CodeCharge Studio
search Register Login  

Web Reports

Visually create Web Reports in PHP, ASP, .NET, Java, Perl and ColdFusion.
CodeCharge.com

YesSoftware Forums -> CodeCharge Studio -> Wishes

 JavaDoc / phpDoc / doxygen ==> documented code

Print topic Send  topic

Author Message
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
View profile  Send private message

Add new topic Subscribe to topic   


These are Community Forums for users to exchange information.
If you would like to obtain technical product help please visit http://support.yessoftware.com.

MS Access to Web

Convert MS Access to Web.
Join thousands of Web developers who build Web applications with minimal coding.

CodeCharge.com

Home   |    Search   |    Members   |    Register   |    Login


Powered by UltraApps Forum created with CodeCharge Studio
Copyright 2003-2004 by UltraApps.com  and YesSoftware, Inc.