LotusScript Comment Templates for lsdoc.org (aka LotusScript.doc, aka Javadoc for LotusScript)

I am a big fan of Mikkel Heisterberg’s lsdoc.org for automatic help-page generation for LotusScript code. If you are not familiar with lsdoc.org, it’s similar to javadoc, but for LotusScript.

Ever since the advent of Code Templates, I’ve been using lsdoc-compatible syntax for my comments, and I wanted to share it with you here:

Comment Template – Sub

'/*************************************************************************************
' * ${element_type} ${element_name}
' * @param 
' * @author ${author}
' * @version ${date}
' *************************************************************************************/

Comment Template – Function

'/*************************************************************************************
' * ${element_type} ${element_name}:A function to
' * @param
' * @return
' * @author ${author}
' * @version ${date}
' *************************************************************************************/

Comment Template – class

'/*************************************************************************************
' * A Class to represent
' * @author ${author}
' * @version ${date}
' *************************************************************************************/

 
Update:
lsdoc.org is down, Mikkel unfortunately did not renew the domain name and it’s been taken over by some domain parkers. May they rot in hell, those guys! Mikkel told me that he will be probably loading the tool onto openntf, after Easter 2014, so please be patient.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s