Coding and Documentation Standards

Coding Standards

As an open source project, contributions to BrainGrid are welcome by the community, including undergraduates and graduates at the University of Washington Bothell (though contributions from other sources are fine too!). Due to its open source nature, BrainGrid gets quite messy very quickly if standards are not maintained. As such, the following coding standards are to be followed for a pull request to be accepted:

TODO

Commenting Standards

Our approach will be to produce comments for use by Doxygen in .h files and duplicate those comments in the corresponding .cpp files. This is for convenience of human readers/programmers. To prevent Doxygen from being confused (duplicating entries), comments in the .cpp files should start with "/*" or "//", rather than "/**" or "//!", so Doxygen will ignore those comments -- the .h file comments will be the canonical ones for that purpose.