Advanced page of Visual Studio text editor options

SDI includes a version of the Advanced page for Visual Studio text editor options for Synergy DBL. This page has options for entering outlining mode and for warning suppression. To access this page, select Tools > Options, and then select Text Editor > Synergy DBL > Advanced in the navigation pane of the Options dialog box.

Settings on the Advanced page can be imported and exported using Visual Studio’s Import and Export Settings Wizard (Tools > Import and Export Settings). Select the Advanced Dialog Page option on the “Choose Settings to Export” or “Choose Settings to Import” screen of the wizard.

To submit a comment on the Advanced page, use the comment button (Feedback icon) in the top right corner.

Import Directives

Place ‘System’ directives first when sorting imports

Not implemented.

Suggest imports for types in reference assemblies

Not implemented.

Suggest imports for types in NuGet packages

Not implemented.

Highlighting

Highlight references to symbol under cursor

Not implemented.

Highlight related keywords under cursor

Not implemented.

Outlining

Enter outlining mode when files open

Makes blocks of code collapsible. When a file is first opened, the editor collapses .region blocks and blocks of inactive code.

Editor Help

Underline errors in editor

Displays red wavy underlines (squiggles) for errors in code, and displays green wavy underlines for warnings.

Garbage Collection

Enable feature to force garbage collection

Select this to enable SDI’s ad hoc (manually triggered) garbage collection feature—i.e., the “Force Debug Garbage Collection” entry in the Tools menu. Selecting the “Force Debug Garbage Collection” menu entry triggers garbage collection, including cleanup of COM objects managed by the Synergy .NET debugger. We recommend disabling this functionality (by clearing this check box) unless this feature is necessary—for example, in debugging scenarios where objects are persisting longer than required and need to be cleaned up. Note that enabling this functionality may cause performance issues (slowdowns or hangs) due to attempts to clean up data before it is consumed.

XML Documentation Comments

Generate XML documentation comments for ; ; ;

Not implemented. XML documentation is automatically generated for documentation comments (comments marked by ;;;).

You can use the Synergy “Doc comment” snippet (shortcut: “;;;”) or the “Documentation comment” snippet (shortcut: “comment”) to insert a documentation comment:

;;; <summary>
;;;
;;; </summary>

See Documentation comments for information on using these comments.

Implement Interface

Surround generated code with .region

Not implemented.

Warnings

Suppress project platform target and active configuration mismatch warnings

Prevents Visual Studio from reporting warnings about mismatched platform target and project platform settings. For example, unless this option is selected, the following warning is reported if “Platform target” (on the Build page of project properties) is set to x86 for the Any CPU project platform:

“Project platform target and active configuration mismatch detected. Active configuration platform is Any CPU. Actual project platform is x86.”

Up-to-date Check

Allow logging information about project up-to-date checks

Enables SDI telemetry to collect the following information to help Synergex better understand Synergy project builds: project inputs, project outputs, build time, whether a project is up to date, and information on any project items that are out of date. Note the following, and see Synergy DBL Integration Improvement Program (SDI telemetry) for more information.

  • This setting is used only if you have chosen to participate in the Synergy DBL Integration Improvement Program.
  • To clear build-related Information from memory (information collected by SDI telemetry for the current Visual Studio session), select Tools > Flush Project Up-To-Date Telemetry Data.

Telemetry IDs

Session

A randomly generated telemetry ID for the current Visual Studio session. This may be requested by Synergex and is used to help Synergex troubleshoot issues with SDI and Synergy projects. If you send this ID to Synergex when encountering an SDI-related issue in the current Visual Studio session, Synergex can use this ID to identify the telemetry data for the session.

Client

A randomly generated telemetry ID for your machine. This may be requested by Synergex and is used to help Synergex troubleshoot issues with SDI and Synergy projects. If you send this ID to Synergex when encountering an SDI-related issue, Synergex can use this ID to identify the telemetry data for your machine.