Blog For Free!
Archives
Home
2008 September
2008 July
2008 May
2007 September
2007 August
2007 June
2006 December
2006 November
2006 September
2006 July
2005 December
2005 September
2005 February
2004 December
2004 October
tBlog
My Profile
Send tMail
My tFriends
My Images
Sponsored
Blog
|
| C++ |
| 08.06.07 (11:45 pm) [edit] |
|
C++
There are a number of good reasons to document your code, and a number of aspects of it that can be documented. Documentation provides you with a shortcut for obtaining an overview of the system or for understanding the code that provides a fastidious feature.
Why?
The idea of comments is to clarify and clarify the source code to anyone examining it. Good comment conventions are important to any non-trivial agenda so that a person reading the code can understand what it is expected to do and to make it easy to follow on the rest of the code
1) Certification of programming is essential when programming not just in C++, but in any programming language. Many companies have moved away from the idea of "hero programmers" to a concept of groups of programmers working in a team. Many times programmers will only be working on small parts of a larger project.
Even if you are not programming for a living or for a company, documentation of your code is still essential. Though many programs can be completed in a few hours, more complex programs can take longer time to complete (days, weeks, etc.). In this case, documentation is essential because:
I. You may not be able to work on your project in one sitting;
II. It provides a reference to what was changed the last time you programmed;
III. It allows you to record why you made the decisions you did, including why you chose not to explore certain solutions;
IV. It can provide a place to document known limitations and bugs;
V. It allows easy searching and referencing within the program;
|
|
|
| |
|
|
