Coding and Documentation Standards

There is no definitive way to write code. Like any artistic creation we all have our preferred style and idiosyncracies, therefore we at CodeCogs.com have no intention of dictating any particular approach. That said, we would like to encourage uniformity across our site so making it easier for all our users to read and reuse the available code.

Why?

In general, coding conventions are necessary to ensure a high standard of code quality, readability, consistency and maintainability across the development team. Code that follows no meaningful pattern is hard to follow, hard to debug, and hard to maintain. The documents below define a simple set of conventions and guidelines for writing C/C++ code. While programming please also keep the following facts in mind:

Our documentation standards are less flexible than you may be used to due to the approach we take in generating the 'clear' documentation pages you see on this site. Aside from these technical constraints the quantity of documentation is up to you. The better your documentation, then the easier it will be others to follow - and if you're selling licenses, then you stand a better chance of selling them if it is packaged well (just like presenting anything for sale in a shop).

CodeCogs.com Standards

Need help learning C/C++?

If you are fairly new to programming there are many resources available on the internet dedicated to helping you learn C/C++. One of the best sites available is www.cprogramming.com. It is a site dedicated to learning C/C++ and provides tutorials, challenges, quizzes, general information and tips on all aspects of programming.