dirksamson
Posts: 32
|
| Posted: 01/26/2007, 12:13 AM |
|
As projects grow larger, good code documentation is indispensible. Would it be a good idea to generate some in-file code documentation that javadoc/phpdoc and others can understand? I think the format can be quite generic and a short description of the Classes and methods of CCS would greatly improve the usability of the code! Even if it where only a @package declaration at the top of each file....
@see http://www.phpdoc.org
@see http://java.sun.com/j2se/javadoc/writingdoccomments/
... and many others
/**
* This file contains all "codecharge foundation classes"
*
* @package codecharge
* @author Mr Code Charge <code@yessoftware.com>
* @copyright YesSoftware, 2007
*/
_________________
Dirk |
 |
 |
|
