devgrind » documentation http://devgrind.com thinking outside the { } Tue, 04 May 2010 17:25:24 +0000 http://wordpress.org/?v=2.9.2 en hourly 1 Google Code Search http://devgrind.com/2008/10/23/google-code-search/ http://devgrind.com/2008/10/23/google-code-search/#comments Thu, 23 Oct 2008 08:50:35 +0000 Magnus http://devgrind.com/?p=53 This must be either really new or – what seems more likely – I have slept over Google’s developments the last year. Google Code allows for a regular-expression-based search in publicly available source code. Nice one.

]]> http://devgrind.com/2008/10/23/google-code-search/feed/ 0 Documentation Note http://devgrind.com/2008/07/23/documentation-note/ http://devgrind.com/2008/07/23/documentation-note/#comments Wed, 23 Jul 2008 15:24:45 +0000 Magnus http://devgrind.com/?p=45 If you are documenting Java methods, try to fit everything really important (like constraints for the method) into the first sentence of the javadoc. This sentence is displayed along wiht the overview of the class method.

Everything after the first sentence vanishes in the distance where no-one will ever read it.

]]> http://devgrind.com/2008/07/23/documentation-note/feed/ 0