Skip to content
Snippets Groups Projects
Commit d01d873e authored by wfg's avatar wfg
Browse files

Added in doc directory:

1) Doxygen file
2) Coding Guidelines document
parent e2850c08
No related branches found
No related tags found
1 merge request!8Integrate groupless
CodingGuidelines
Created on: Sep 30, 2016
Author: wfg
Introduce coding guidelines that all developers must follow as standard practice.
Objectives:
1) Improve collaboration:
1.a. Reduce new code development and integration times for developers and users, by making code easy to understand
1.b. Allocate more time for discussion and pathfinding rather than understanding developers code
1.c. Expand developers and users base
2) Execute new ideas faster
3) Allocate more time to research and publication from new ideas
C++ coding guidelines
Text
1) Use meaningful English words or well-known acronyms.
Classes / Structs
1) Classes will be initialized with a upper case "C" following by an upper, example: ( CADIOS, CNETCDF, CPHDF, C )
2) Structs will be initialized with a upper case "S" and prefereed for plain old data, example: ( SVariables, S )
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment