Updated NEP 1 : Style Guide for Nimrod Code (markdown)
This commit is contained in:
parent
11631597d7
commit
9dc3982c23
|
@ -118,4 +118,37 @@ General
|
||||||
- Use of extra whitespace for alignment is discouraged. This is not
|
- Use of extra whitespace for alignment is discouraged. This is not
|
||||||
necessarily because such a alignment is bad, but because of the varying
|
necessarily because such a alignment is bad, but because of the varying
|
||||||
support editors have for auto-alignment of text, and the fact that manual
|
support editors have for auto-alignment of text, and the fact that manual
|
||||||
alignment and re-alignment can be quite time consuming.
|
alignment and re-alignment can be quite time consuming.
|
||||||
|
|
||||||
|
Incorrect:
|
||||||
|
|
||||||
|
```nimrod
|
||||||
|
type
|
||||||
|
WORDBOOL* = int16 # XXX: not a bool
|
||||||
|
CALTYPE* = int
|
||||||
|
CALID* = int
|
||||||
|
CCHAR* = char
|
||||||
|
TCOLORREF* = COLORREF
|
||||||
|
WINT* = int32
|
||||||
|
PINTEGER* = ptr int32
|
||||||
|
PBOOL* = ptr WINBOOL
|
||||||
|
LONGLONG* = int64
|
||||||
|
PLONGLONG* = ptr LONGLONG
|
||||||
|
LPLONGLONG* = ptr LONGLONG
|
||||||
|
```
|
||||||
|
|
||||||
|
Correct:
|
||||||
|
```nimrod
|
||||||
|
type
|
||||||
|
WORDBOOL* = int16 # XXX: not a bool
|
||||||
|
CALTYPE* = int
|
||||||
|
CALID* = int
|
||||||
|
CCHAR* = char
|
||||||
|
TCOLORREF* = COLORREF
|
||||||
|
WINT* = int32
|
||||||
|
PINTEGER* = ptr int32
|
||||||
|
PBOOL* = ptr WINBOOL
|
||||||
|
LONGLONG* = int64
|
||||||
|
PLONGLONG* = ptr LONGLONG
|
||||||
|
LPLONGLONG* = ptr LONGLONG
|
||||||
|
```
|
Loading…
Reference in New Issue