Do you know any tools that can run through the code and find defects in javaDoc blocks? (would be nice to parse other languages also, like PHP, C#, etc).
views:
30answers:
3
A:
Doxygen reports errors in the documentation. Depending on how it is configured it can also report when documentation is missing.
A similar question (but not exactly the same): http://stackoverflow.com/questions/2580215/is-there-a-way-to-validate-the-presence-of-javadoc-and-or-inline-code-comments/2580312
Anders Abel
2010-04-07 06:17:54
+1
A:
PHPDocumentor will give you a list of errors, in the case of phpDoc.
Evert
2010-04-07 06:26:11
Could you please explain how exactly I can get a list of errors with phpDoc? I can't find this in their documentation. Thanks!
Vincenzo
2010-05-05 17:33:55
I believe it actually makes a errors.html file. Also, when I run it, it spits out tons of warnings for me. By default it also displays them in the console, unless -quiet is used.
Evert
2010-05-06 07:19:20
A:
I recently started a open source JavaDoc checking utility: OpenJavaDocCheck. The project is fairly young, but some features are:
- XHTML+RDFa output (or just XML, so that you can use XSLT to create whatever)
- extensible (to test for project specific JavaDoc patterns, such as custom tags)
Egon Willighagen
2010-06-13 14:52:31