mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-01-14 08:49:45 -05:00
CodingStyle changed
Comments identation
This commit is contained in:
parent
f94d715cc1
commit
92d58e4492
@ -40,6 +40,17 @@ General typographic conventions
|
|||||||
|
|
||||||
- **Use descriptive names for variables and functions**! Really, these days, when most editors have auto-completion feature, there is no excuse for using short variable names.
|
- **Use descriptive names for variables and functions**! Really, these days, when most editors have auto-completion feature, there is no excuse for using short variable names.
|
||||||
|
|
||||||
|
- Comments should be indent together with the code, e.g. like this:
|
||||||
|
|
||||||
|
``` {.wiki}
|
||||||
|
for (...) {
|
||||||
|
// The following code finds PGP private key matching the given public key in O(1)
|
||||||
|
while (key_found) {
|
||||||
|
(...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
File naming conventions
|
File naming conventions
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user