I have these comment templates that automatically make lsdoc-compatible stubs to my classes, subs and functions.
The real killer application for lsdoc.org is that I have a system documentation which is available with very little effort. Whenever a client says 'what about the documentation', I print out the HTML files relating to the project databases, and I am a hero.
The Lsdoc.org makes clickable documentation files, and I find makes a very nice display of the way different classes link to each other.
I love lsdoc.org!
I have these comment templates that automatically make lsdoc-compatible stubs to my classes, subs and functions.
The real killer application for lsdoc.org is that I have a system documentation which is available with very little effort. Whenever a client says 'what about the documentation', I print out the HTML files relating to the project databases, and I am a hero.
The Lsdoc.org makes clickable documentation files, and I find makes a very nice display of the way different classes link to each other.
Here are my snippets:
Class:
'/*************************************************************************************
' * A Class to represent
' * @author ${author}
' * @version ${date}
' *************************************************************************************/
Function
'/*************************************************************************************
' * ${element_type} ${element_name}
' * @param
' * @return ${element_returntype}
' * @author ${author}
' * @version ${date}
' *************************************************************************************/
Sub
'/*************************************************************************************
' * ${element_type} ${element_name}
' * @param
' * @author ${author}
' * @version ${date}
' *************************************************************************************/