FlexSEA Wiki

A WEARABLE ROBOTICS TOOLKIT

User Tools

Site Tools


styleguide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
styleguide [2019/08/30 17:39]
jfduval
styleguide [2019/09/11 19:07] (current)
jfduval
Line 7: Line 7:
   * Do not use ''/​* */''​ for comments that are on a single line, use <​nowiki>​ // </​nowiki>​   * Do not use ''/​* */''​ for comments that are on a single line, use <​nowiki>​ // </​nowiki>​
   * As a general rule, make sure that your code looks clean and similar to the existing code (when existing code is provided)   * As a general rule, make sure that your code looks clean and similar to the existing code (when existing code is provided)
-  * In your comments, start sentences with capital letters.+  * In your comments, start sentences with capital letters. ​Do not put a space between the <​nowiki>//</​nowiki>​ and the text. 
 +    * Good: <color #​22b14c><​nowiki>//​That'​s a good comment</​nowiki></​color>​ 
 +    * Bad: <color #​ed1c24><​nowiki>//​ this isn'​t</​nowiki></​color>​
   * Always include a comment above a function declaration that explains its purpose.   * Always include a comment above a function declaration that explains its purpose.
   * Always mention in what file extern variables are declared.   * Always mention in what file extern variables are declared.
styleguide.txt · Last modified: 2019/09/11 19:07 by jfduval