<< 19 April 2007 | Home | 21 April 2007 >>

Preferred LotusScript comment style

As previously mentioned I'm looking into starting development of LotusScript.doc version 2 and for that I'm also rethinking how comments are written when writing LotusScript. In version 1 of LotusScript.doc I have only supported a LotusScript'ified version of the Javadoc syntax which meant that only the following comment syntax is considered valid: 

'/**
' * This is my comment for the DoStuff sub-routine.
' */
Public Sub DoStuff()
   ...
End Sub
Comments of this kind can be placed inside or outside of code constructs (class, sub, function etc.) and will be picked up by LotusScript.doc accordingly. Apart from this you can write a description for a design element by using the lsdoc_description() sub-routine. This is the equivalent of the package.html from javadoc. Normally it would be used like this: 
Private Sub lsdoc_description
%REM

%END REM
End Sub

For LotusScript.doc v. 2 I would like to make this more flexible and support multiple commenting schemes so I'm thinking:

  • "How do you comment your LotusScript?"
    • Do you comment using %REM sections?
    • Do you comment inside or outside the sub/function/class etc.?
    • How do you document the design element it self?
Also - one thing is how you do it now - another is how would like to document your code in the future.

I would really appreciate any input...

Tags : , ,
Responses[12] RSS feed for responses to this blog entry
Posted by Mikkel Flindt Heisterberg on 20 April 2007 16:54:24 CEST #