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/11/07 20:47]
jfduval
styleguide [2020/03/23 20:44] (current)
rharris
Line 8: Line 8:
   * 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). More examples below.   * As a general rule, make sure that your code looks clean and similar to the existing code (when existing code is provided). More examples below.
-  * In your comments, start sentences with capital letters. ​Put a space between the <​nowiki>//</​nowiki>​ and the text.+  * 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>​     * Good: <color #​22b14c><​nowiki>//​That'​s a good comment</​nowiki></​color>​
     * Bad: <color #​ed1c24><​nowiki>//​ this isn'​t</​nowiki></​color>​     * Bad: <color #​ed1c24><​nowiki>//​ this isn'​t</​nowiki></​color>​
styleguide.txt ยท Last modified: 2020/03/23 20:44 by rharris