Skip to content

Commit

Permalink
Version 3.9:
Browse files Browse the repository at this point in the history
+ Double-tapping Shift key to show Smart Bar and option to control the auto display of it
+ Tweaked Smart Bar display position
+ Added more commands to Smart Bar
+ Added an alternative style for C# Quick Info
+ Better theming and preview of syntax style config pages
+ Symbol marker command enhancements
+ Inherited <remarks> XML Doc
+ Updated documentation for Codist
  • Loading branch information
wmjordan committed Sep 28, 2018
1 parent 1dc9801 commit bd1a145
Show file tree
Hide file tree
Showing 15 changed files with 34 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Codist/CodistPackage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace Codist
/// <para>The project consists of the following namespace: <see cref="SyntaxHighlight"/> backed by <see cref="Classifiers"/>, <see cref="SmartBars"/>, <see cref="QuickInfo"/>, <see cref="Margins"/>, etc.</para>
/// </summary>
[PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]
[InstalledProductRegistration("#110", "#112", "3.8", IconResourceID = 400)] // Information on this package for Help/About
[InstalledProductRegistration("#110", "#112", "3.9", IconResourceID = 400)] // Information on this package for Help/About
[Guid(PackageGuidString)]
[ProvideOptionPage(typeof(Options.General), Constants.NameOfMe, "General", 0, 0, true)]
[ProvideOptionPage(typeof(Options.SuperQuickInfo), CategorySuperQuickInfo, "General", 0, 0, true, Sort = 0)]
Expand Down
2 changes: 1 addition & 1 deletion Codist/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
[assembly: AssemblyCulture("")]
[assembly: ComVisible(false)]
[assembly: AssemblyVersion("3.0.0.0")]
[assembly: AssemblyFileVersion("3.8.0.2243")]
[assembly: AssemblyFileVersion("3.9.0.2259")]
2 changes: 1 addition & 1 deletion Codist/source.extension.vsixmanifest
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
<Metadata>
<Identity Id="Codist.WMJ.c7b93d20-621f-4b21-9d28-d51157ef0b94" Version="3.8.0.2230" Language="en-US" Publisher="WMJ" />
<Identity Id="Codist.WMJ.c7b93d20-621f-4b21-9d28-d51157ef0b94" Version="3.9.0.2256" Language="en-US" Publisher="WMJ" />
<DisplayName>Codist</DisplayName>
<Description xml:space="preserve">A Roslyn-powered C# coding experience enhancer with advanced syntax highlight, Super Quick Info (code tooltip), Smart Bar, Code Structure Markers on scrollbar, comment tagger, and more.</Description>
<MoreInfo>https://github.com/wmjordan/Codist</MoreInfo>
Expand Down
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,14 @@

![Syntax highlight](doc/highlight1.png)

**NOTE**: To quickly get started with advanced syntax highlight, navigate to the *Syntax Highlight* section, click the *Light theme* or *Dark theme* button in the *options* dialog and see them in effect. Don't forget to click the *OK* button to confirm the change.
### Default syntax highlight themes

To quickly get started with advanced syntax highlight, navigate to the *Syntax Highlight* section, click the *Light theme* or *Dark theme* button in the *options* dialog and see them in effect. Don't forget to click the *OK* button to confirm the change.

![Load Theme](doc/load-theme.png)

### Customization of syntax highlight styles

To customize and tweak the syntax highlight styles, click the *common syntax* tab in the *syntax highlight* section, or click the sub sections inside the *Syntax Highlight* section to change individual styles, accordingly.

![Style customization](doc/syntax-highlight.png)
Expand Down Expand Up @@ -152,7 +156,7 @@ The scrollbar can mark...

## Smart Bar

The *Smart Bar* is a context-aware tool bar appeared automatically when you select some text.
The *Smart Bar* is a context-aware tool bar appeared automatically when you select some text, or double tap the Shift key on your keyboard.

It brings commonly used operations for the selection.

Expand All @@ -166,6 +170,30 @@ From version 3.7 on, when you select a symbol and click the *Analyze references.

![Smart Bar Symbol Analysis](doc/smart-bar-symbol-analysis.png)

From version 3.9 on, you can change the behavior of the Smart Bar.

![Smart Bar Options](doc/smart-bar-options.PNG)

### Symbol markers

Symbol marker is a new feature introduced in version 3.8.

Typically, you can double click a symbol in the C# source code, select the *Mark Symbol* command on the *Smart Bar* and choose the desired highlight marker on the drop-down menu.

![Symbol Marker](doc/symbolmarker.png)

After applying the command, all occurrences of the marked symbol will be marked with a different style.

![Symbol Marker Effect](doc/symbolmarker-effect.png)

To remove symbol marker, click the *Remove symbol mark* command in the drop-down menu of the *Mark symbol* command.

Symbol markers will be cleared when the solution is unloaded.

The style of symbol markers can be customized in options page of the *Syntax highlight* feature.

![Symbol marker Options](doc/symbolmarker-options.png)

# Feature control
Open the *Codist* section in the *Tools->Options* dialog. In the *General* section you can toggle features of *Codist*.

Expand Down
1 change: 1 addition & 0 deletions TestProject/TestPage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ static string[] List(int value, params string[] text) {
/// <summary>A generic delegate with a parameter.</summary>
/// <typeparam name="TObject">The generic type parameter of the delegate.</typeparam>
/// <param name="obj">The method parameter of type <typeparamref name="TObject"/>.</param>
/// <remarks>Don't take this too serious.</remarks>
/// <returns>Returns an instance of the generic type parameter.</returns>
delegate TObject Clone<TObject>(TObject obj);
event EventHandler<EventArgs> MyEvent;
Expand Down
Binary file modified doc/comment-tagger-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/csharp-options-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/csharp-options-symbolmarker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/csharp-options-xmldoc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/general-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/smart-bar-options.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/symbolmarker-effect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/symbolmarker-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/symbolmarker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/syntax-highlight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bd1a145

Please sign in to comment.