• RSS Feed

Document Method

Document Method is a quick and simple way to add a comment block prior to a method. Components of the method, e.g. return value and parameters, are listed on separate lines of the block so you can document their meanings individually.

Invoke Document Method while the caret is over the declaration or definition of a method from the context menu (Right-Click or Shift+F10) of the text editor or from the Quick Refactoring Menu (Shift+ALT+Q).

A comment block is created prior to the method.

Format of Comment Block

You can modify the format of comment block by editing the VA Snippet for Document Method.

The VA Snippets entries include special characters expanded only when refactoring and generating code. 

See Also

Use VA Snippets for Refactoring for more advanced documentation.