By: Burke Autrey

Burke Autrey — Mon, 26 Jul 2010 16:12:57 +0000

Excellent response. Thank you.

By: juan paul

juan paul — Sat, 24 Jul 2010 21:02:08 +0000

Sure thing: lets start by defining our application as a Maven-built Java ball of code laced with Javadoc notes within a series of methods and conditional branches. We then ensure that our Hudson continuous build servers have the Sonar plugin installed, and that our Maven builds define the Sonar goal each and every time. Much in the same way your jUnit code can be instrumented for test coverage by, say Cobertura, Sonar can walk through your exact source to detect the presence of commented headers per function/method/class. (The Sonar codehaus metrics page provides a good description of the metrics gathered and formula for deriving them. Sonar in a nutshell provides even more detailed screenshots and examples of 'walking down' your instrumented code. ) Again similar to cobertura and unit test coverage, the javadoc instrumentation does not tell you necessarily whether the documentation written is accurate and/or helpful, but at least gives you a very good starting point for detecting what has failed to have been documented at all. A compelling add-on to cpan's Devel::Cover (think Cobertura for Perl,) would allow you to perform the same measurements from your perldoc decorated code as well. Glad you enjoyed the video and as always, drop me a line with any additional questions or comments.

By: Burke Autrey

Burke Autrey — Thu, 22 Jul 2010 19:50:00 +0000

Juan Paul – enjoyed the video and this post. Can you provide some insight on how you measure documentation coverage?

Comments on: Bringing Dev and Ops closer together through metrics and dashboards

By: Burke Autrey

By: juan paul

By: Burke Autrey