LotusScript.doc is a Notes application to generate HTML documentation for LotusScript code in Notes databases. LotusScript aims to be for LotusScript what javadoc is for Java. If you're not familiar with javadoc I have prepared a small introduction to javadoc.

Why you need LotusScript.doc
Code in a Notes application is very hard and time consuming to document since there is no standard way of doing it. With the increasing complexity of Notes/Domino applications we really lack tool support like what javadoc provides for the Java programming language.

Because of the difficulty and time consuming it is to provide code documentation in Notes we (Notes/Domino developers) normally only document the actual application (the user manual). This is a shame since it makes team development, future maintenance and component development harder than it already needs to be.

LotusScript.doc aims to provide you with this standard, easy way of producing professional looking code documentation.

How it works
LotusScript.doc works by parsing the LotusScript code in a Notes/Domino application looking for a special comment syntax. Based on the special comments found, a hyperlinked HTML documentation is created that allows for easy sharing and browsing.

For examples please refer to the screenshots-section.

But I still need to write the documentation...
Well yes! But even without any comments added to your code the documentation generated by LotusScript.doc will still make it much easier for you to share and navigate your code since it provides a (quick-)reference to your design elements and how methods should be called.

Adding actual documentation using annotations is icing on the cake.

The examples below show the documentation of the code from the excellent DominoWiki without any comments added. As you can see the code is easier to read and navigate even without any added comments.



Just imagine what adding comments will do!

I blog regulary at lekkimworld.com