forked from serp83/iisis.singlec.iis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcodeConventions.txt
29 lines (26 loc) · 1.51 KB
/
codeConventions.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
1.Название класса в верблюжей аннотации;
2. При изменении имени обработки(класса), необходимо изменить в конфигураторе параметры Имя и Синоним текущего класса
3. Правильное написание кода:
а) Чередование параметров метода:
Function(a, b, c) - правильно
Function(a,b,c) - неправильно
б) Присвоение значения переменной:
a = b; - правильно
a=b; - неправильно
4. Изящность написания кода заключается не в том, что реализация алгоритма написана в одну строчку, а в наглядности и простоте.
Если же код при его анализе другим специалистом вызывает сложности - это неправельный выбор архитектуры. Разбейте код на простые задачи,
разделите на различные методы. Каждый метод должен выполнять одну задачу, сформированную одним глаголом(Получить,Записать,Распределить).
Если же нет возможности реализовать код по этим правилам, обязательно в сложных местах сделайте подробный комментарий вашего кода, тем самым вы
упростите задачу и себе(если вернетесь к этому участку через пару лет) и другим специалистам.
5.Правила формирования переменных:
ObjectList - для ValueList, ValueTable;
ObjectListRow - для конкретной сущности из ObjectList
Objects - для Array;
Object - для конкретной сущности из Array;
ObjectMap - для Structure, Map;
Item - для конкретной сущности из ObjectMap;
6. Каждый класс имеет предопределенные методы:
Function Command(Command, ...) Export
Function CC(ClassName, Command, ...)
Function Init()
Методы Command и CC должны всегда находится в самом низу класса поочередно сначала Command потом CC.