ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Dot​Net​Comments

by juzzbott ST2/ST3

Visual Studio style XML comments in Sublime Text

Labels comments

Details

Installs

  • Total 869
  • Win 656
  • OS X 142
  • Linux 71
Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9
Windows 0 0 0 0 1 0 0 1 0 0 0 0 0 1 0 1 0 0 1 2 1 1 0 1 0 0 2 0 0 3 0 0 1 0 0 0 0 0 1 0 0 0 1 0 0 1
OS X 0 0 1 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

DotNetComments

DotNetComments is a plugin for Sublime Text 3 that replicates the commenting functionality of Visual Studio.

To use the plugin, type '///' and the plugin with automatically determine the type of comment block to generate based on the next line of code. The plugin will ignore [Attributes] so that is able to correctly determine the comment type.

Once the comment block has been generated, the cursor is automatically shifted to the entry section for the <summary> so that typing is unimpeeded.

Supported comment types

The plugin can support the following comment types: * Properties and fields * Classes, interfaces and enumerations * Contstructors * Methods (both with and without return values) * Generic TypeParam methods ()

Examples

Property comment block:

/// <summary>
/// 
/// </summary>
private int _someValue { get; set; }

Generic method with return value:

/// <summary>
/// 
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="objectId"></param>
/// <param name="count"></param>
/// <returns></returns>
public static T GetObject<T>(string objectId, int count)
{
}

Supported versions

So far, this has only been tested on Sublime Text 3, as it's designed to work along side plugins like OmniSharp. When I get a chance, I'll test this on Sublime Text 2.