Mantis Bug Tracker

View Issue Details Jump to Notes ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0000010FirmwareStructure / Stylepublic2008-10-29 16:282009-01-02 14:57
ReporterFred 
Assigned ToFred 
PrioritylowSeverityminorReproducibilityN/A
StatusclosedResolutionfixed 
PlatformOSOS Version
Product Version 
Target Version0.0.19-DoxygenatedFixed in Version0.0.19-Doxygenated 
Summary0000010: Document And Standardise Upon Coding Conventions
DescriptionCurrently the coding style is only consistent within modules. Inter module it has some inconsistencies that aren't serious, but should be fixed.

We need to define formal coding conventions and then format all the code and adjust all the variables to be in line with that style.

Some examples of things that need to be defined are :

* Case, upper, lower, camel, leading upper on camel or not, etc. This needs to be done for each class of identifier. eg defined constants, const constants, local vars, global vars, function names, etc
* tabs/spaces/length of tabs, locations of braces, spaces between if( or if ( blank lines between block of code, etc
* file naming conventions similar to identifiers
* comments, size, type, location, chars to EOL etc
* GNU GPL header MUST be in place before release
* Some specific prefixes standardised upon for identifiers related to certain modules etc
* header structure standard - needs to be defined, see related task
* where multiple terms exist for a single thing, define which to use

Probably other things, suggestions on the above and additional things most welcome.
TagsNo tags attached.
FirmwareVersion
Issue TypeImprovement
Risk of Breakage
Attached Files

- Relationships

-  Notes
User avatar (0000143)
Fred (administrator)
2009-01-02 14:57

This is now part of the source and a work in progress. It will be an on going thing to keep the guide reasonable and up to date and keep the source inline with that.


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker