LabWindows/CVI Idea Exchange

cancel
Showing results for 
Search instead for 
Did you mean: 
0 Kudos
40tude2

Documentation tags improvement - New tags that define blocks

Status: New

So far the documentation is written line by line with a tag at the begining of each line. See below : 

/// HIFN Document your function here.
/// HIFN You may use multiple lines for documentation.

 

It could be nice to add a tag attribute that helps to define regions (or blocks) of documentation. See below :

/// HIFN BEGIN
//  Document your function here.
//  HIFN You may use multiple lines for documentation.
/// HIFN END

 

Once done this would help to copy/paste large section of existing documentation. Regarding the "// " that need to be added I believe that a macro or a new editing option ("comment multiline" or "comment selection" like in VBA) could do the job 🙂

 

Regards, 40tude

 

 

1 Comment
40tude2
Member

Ooops!

Regarding the very last part of the previous post about commenting I realize the option is "almost" already there

Indeed when some lines are excluded the "Comment" button of the Edit/Resolve All excluded lines option already add "// " at the beginning of the lines.

This is a pretty good news because this means less work to implement the proposed idea 🙂

Regards, 40tude