Confirmed users
1,059
edits
DevTools/CodingStandards: Difference between revisions
→Comments: added point describing format of bullet points in comments
(→Running ESLint in Emacs: Added flycheck-verify-setup advice.) |
(→Comments: added point describing format of bullet points in comments) |
||
| Line 174: | Line 174: | ||
* A global comment at the very top of a file explaining what the file is about and the major types/classes/functions it contains is a good idea for quickly browsing code. | * A global comment at the very top of a file explaining what the file is about and the major types/classes/functions it contains is a good idea for quickly browsing code. | ||
* If you are forced to employ some kind of hack in your code, and there's no way around it, then add a comment that explains the hack and why it is needed. The reviewer is going to ask for one anyway. | * If you are forced to employ some kind of hack in your code, and there's no way around it, then add a comment that explains the hack and why it is needed. The reviewer is going to ask for one anyway. | ||
* Bullet points in comments should use stars aligned with the first comment to format each point | |||
<code><pre> | |||
// headline comment | |||
// * bullet point 1 | |||
// * bullet point 2 | |||
</pre></code> | |||
== Asynchronous Code == | == Asynchronous Code == | ||