This project is read-only.
Project Description
A clean, sleek commenting guide, along with arg checking, and file structure.


Purpose

Throughout my career thus far, I've noticed so many different patterns when it comes to basic concepts of software development. Particularly in the field of commenting, documentation, and file structure. The purpose of this guide is to take the best of what I think is a good guideline for ensuring your code is well defined and documented, your public API is error checked, and your file structure is easy to follow.

companyComments.jpg

The above is a basic snap shot of a collapsed public API for an Employee. The code is very small, and basic. It should provide a good understanding of arg checking, documenting your public API's, and structuring your files in a readable fashion to other developers.

If you work on a team, or just want to develop a guideline and standard for the way your write code, then I suggest downloading and browsing through the code.

Last edited Mar 9, 2009 at 1:50 PM by mariocatch, version 2