You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

23 lines
961 B

  1. /* ---------------------------------- GUIDELINES FOR STORM DEVELOPMENT ---------------------------------- */
  2. In general, we adhere to the Google Styleguide for C++, found under http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
  3. - C++ file names are <class>.h and <class>.cpp
  4. - all Source Code is to reside in the src/ Directory or an appropriate subdirectory, apart from Third-Party Librarys and modules stored under resources/
  5. - all Source Code is to be documented using DoxyGen Syntax:
  6. /*! \brief A chess piece
  7. * The abstract parent of all chess pieces. */
  8. class ChessPiece {
  9. /*! Whether we've moved */
  10. bool bMoved;
  11. /*! Move to P(x, y)
  12. * \param x The x coordinate
  13. * \param y The y coordinate
  14. * \return Whether the move was legal */
  15. bool bMove(int x, int y);
  16. }
  17. - opening brackets on the same line: if (true) {
  18. - always use brackets for "if", "while", "for" and the like, even if it is a one-liner
  19. - use Common Sense