JS Parser looks for "function" declaration and comments of any kind in script. It concatenates on any comments found before next function declaration, calculate function location, length and complexity (depth of logical blocks). You can use it just to browse script file and retrieve list of functions or to warn about functions that are too long or too complex. Parser will display a message box with exclamation icon, if complexity of file/function exceeds 3 and error icon for complexity 5 and above. You are welcome to change rules to fit your coding preferences. Documentation file with the same name as source script and extension "txt" created. In this file Comments, summary, name and parameters are extracted for each function. You can use it as starting point for some real documentation.
Using the code
Browse to directory containing js files. Analyze directory button creates documentation files for each script in selected directory. Double click on file or function to see summary.
Points of interest
Code itself is very simple. There is no equivalent in C# for VB
FileListBox, so I used VB backward compatibility controls.
Some code added to provide
ListView sorting by subitems. See appropriate region in frmMain.cs
Some ideas how we can make this utility more useful:
- Documentation file format certainly can be improved.
- Documentation could be exported as XML even in the same simple schema as VS using for C#. Than you can use other tools to create documentation.
- Open file and browse to function capability, may be useful.
I’ll be glad to receive any suggestions.
Leon works as Chief Architect at SRL Group. He leads architectural design and development of various enterprise level projects.
You can meet him on user groups, conferences and forums dedicated to Architecture, ASP.NET, Team System etc. or join him for the next white water rafting adventure