Skip to content

Commit 0137721

Browse files
committed
Addressed #3, #4
1 parent 467d8ab commit 0137721

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
11
# cos-guidelines
2-
There is required and optional parts. _Optional part to be added later_
3-
## Required part
2+
There is mandatory and recommended parts. _Recommended part to being formed at the moment_
3+
4+
But here is general advice: use common sense and try to *be consistent* wherever you write code.
5+
If there is some style already established in the class or utility being modified then we recommend
6+
to continue use that same style, than introducing yet another one, which may be more recommended
7+
but will produce inconsistent results.
8+
9+
## Mandatory part
10+
411
1. Only "modern" syntax permitted, dotted syntax is not generally allowed (with few exceptions)
5-
2. No short name for statements keywords allowed - use fully expanded, lower case keyword names
12+
2. No short name for statements keywords allowed - use fully expanded keyword names. This same rule applie to builtin function names - they should be fully pronounced.
613

14+
## Recommended part
15+
1. We recommend to use fully expanded keyword in lower case or capitalized. Whatever you'll select should be consistent across class or utility, i.e.
16+
```
17+
If (expression) {
18+
Do ##class(Sample).%New(initexpresion)
19+
For i=1:1:10 {
20+
Write something, $Zversion, !
21+
}
22+
}
23+
```
24+
or
725
```
826
if (expression) {
927
do ##class(Sample).%New(initexpresion)
1028
for i=1:1:10 {
11-
write something,!
29+
write something, $zversion, !
1230
}
1331
}
14-
```
1532
33+
```

0 commit comments

Comments
 (0)