Code Documentation

SVEditor parses Natural Docs style code commenting. This allows pop-ups appear when you mouse over code. You can add a natural docs compliant header above an element in one of the following ways:

• Start a multi-line comment by typing "/**<Enter>" above the element (class, module, package, function, task etc.)
• With your cursor on the element, use invoke the "Add Natural Docs Comment" command by typing "Shift+Alt+J"
• Add comments to an entire file from the "Project Explorer" view
  • Selecting the file(s) in the Project Explorer (use Shift or Ctrl + Shift to select multiple files)
  • Right-click > Source >Add Natural Docs Comment

The Natural Docs specification is available here.

Examples

Function or Task

//////////////////////////////////////

// Function: multiply

//

// This function multiplies 2 operands passed as arguments to the function

//

// Parameters:

// a - int - operand a

//

// b - int - operand b

//

// Returns:

//

// int - a * b

//

//////////////////////////////////////

Module or Class

//////////////////////////////////////

// Class: line

//

// This function extends the base class dot, and is essentially

// 2 dots marking the start and end points of the line

//

//////////////////////////////////////

Making it Easy

If you start a comment with a /** and then hit Enter your comment will automatically be expanded to an appropriate Natural Docs Compliant comment. While an adjustment initially, adding module, class, function comments with SVEditor helping with the indentation as you add your comments makes documentation addition and maintenance significantly easier than using '//'.

/**

* Class: line

*

* This function extends the base class dot, and is essentially

* 2 dots marking the start point and end points of the line

*

*/