Reply New Topic
2007/12/5 8:49:14
#1
Offline
Home away from home

Re: ImpressCMS SVN Repository

I agree with Rules 1-3, and would like to propose another one:

- Rule #4: All committed code must be fully documented.

In part, that means that every function has a phpDocumentor-compliant header comment, which is both correct and understandable, states the purpose of the function and describes the parameters and return value. The same applies to class properties. The header comment for a function (or a class) is intended to be a "mini user manual" for the function that provides all the information needed to call that function, without having to examine the body of the function.

I suppose this won't apply to existing code that you're modifying and don't understand well enough to add missing documentation. Ideally we could review it and figure out together how to document it, but time may not permit that.


Subject Poster Date
     ImpressCMS SVN Repository marcan 2007/12/4 19:38:39
       Re: ImpressCMS SVN Repository Dave_L 2007/12/5 5:41:57
       Re: ImpressCMS SVN Repository marcan 2007/12/5 6:35:07
         Re: ImpressCMS SVN Repository Dave_L 2007/12/5 8:49:14
       Re: ImpressCMS SVN Repository marcan 2007/12/5 11:38:46
         Re: ImpressCMS SVN Repository Dave_L 2007/12/5 12:49:03
           Re: ImpressCMS SVN Repository skenow 2007/12/5 15:55:14
Reply New Topic extras
 Previous Topic   Next Topic
You can view topic.
You can start a new topic.
You can reply to posts.
You cannot edit your posts.
You cannot delete your posts.
You cannot add new polls.
You cannot vote in polls.
You cannot attach files to posts.
You can post without approval.