Skip to content

Commit 692554b

Browse files
committed
Agreed on #8
1 parent 984ca12 commit 692554b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# cos-guidelines
22
This is the first approximation of COS guidelines we use for github.com/intersystems-ru projects. There are mandatory and recommended parts.
33

4-
We do not plan to be too much restrictive, but rather flexible enough to allow many reasonable styles.
4+
We do not plan to be very restrictive, but want be rather flexible enough and allow any *reasonable* style.
55
Here is the general advice: use common sense and try to *be consistent* wherever you write code.
66
If there is some style already established in the class or utility being modified then we recommend
77
to continue use that same style, than introducing yet another one, which may be more recommended
88
but which will be introducing some unnecessary inconsistency.
99

1010
## Mandatory part
1111

12-
* Only "modern" syntax permitted, dotted syntax is not generally allowed (with few exceptions)
13-
* No short name for statements keywords or built-in functions allowed - use fully expanded names.
12+
* Only "modern" syntax permitted, dotted syntax is not generally allowed (with few exceptions);
13+
* No short name for statements keywords or built-in functions allowed - use fully expanded names;
14+
* Comment your code appropriately, use English in comments to make your code easy to understand by your international collegues. Same English-based rule applies to global, local, and type names.
1415

1516
## Recommended part
1617
* We recommend to use fully expanded keyword or function name in lower case or capitalized. Whatever you'll select should be consistent across class or utility, i.e.
@@ -63,4 +64,3 @@ If (expression) {
6364
set j = k + 1
6465
set iN = jN \ l
6566
```
66-
* Please "internationalize" your code - write comments in English, and name globals, locals, or types accordigly.

0 commit comments

Comments
 (0)