Documentation Comment Editing

The Template Editor allows you to easily document your template code. As an added benefit, the documentation you provide will show up in Statement Completion and Quick Info. This will allow you to quickly see what a method, property, or argument does without inspecting the code, therefore saving you valuable time.

Example

In this example we are going to assume that we are editing an existing template that already has some methods defined. We will come across a method that we don't know what its responsibility is. We will then investigate and add some documentation for future reference.

Inspecting the code

We are inspecting existing code and have no idea what the WriteToLog<T> method does (as shown in the image below). We decide to hover over the method to see any comments via Quick Info.

With the lack of documentation we have no idea what the method does. So we do a Go To Definition on WriteToLog and inspect the code.

Adding documentation

Now that we know what the method does, let's add some documentation so anyone using the templates in the future will know what this method does.

When typing /// (CSharp) or ''' (Visual Basic) immediately before a type or member, stub documentation comments will automatically be inserted.

We will now fill out the summary section of the documentation, so others will know what this method does.

Now, when we hover over the WriteToLog<T> method we are prompted with a description!