You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lenya.apache.org by Jörn Nettingsmeier <po...@uni-duisburg.de> on 2006/06/08 00:15:46 UTC

coding style suggestion

reading some older lenya code, for example PageEnvelope.java, i noticed 
  those loads of almost totally redundant javadoc comments like
  /** <code>DOCUMENT_TYPE</code> - the type of the current document
   */

that's akin to those funny examples from kernighan et al, the practice 
of programming:
i++ /* increment local counter by one */

:-D

may i suggest to either write useful commentary or none at all? because 
those do more harm than good by spreading out relevant information over 
several screens. and i don't think the mere existence of javadoc 
comments in your code will get you to heaven already ;)


-- 
"Open source takes the bullshit out of software."
	- Charles Ferguson on TechnologyReview.com

--
Jörn Nettingsmeier, EDV-Administrator
Institut für Politikwissenschaft
Universität Duisburg-Essen, Standort Duisburg
Mail: pol-admin@uni-due.de, Telefon: 0203/379-2736

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org