Пришел постепенно к следующему оформлению кода на Monkey-X .
Имя класса - существительное с неопределённым артиклем:
AClassName
Методы класса и функции - начинаются с глагола и с большой буквы:
DoSomething()
Переменные и поля с маленькой буквы первое слово-существительное-описательное. Остальные слова с большой буквы:
flagUpdate = True
Экземпляры класса могут быть определённым артиклем или без оного, как больше нравится.
TheClassInstance = New AClassName()
Переменные обозначающие массивы, списки, мапы и т.п., т.е. те которые содержат множество элементов одного типа имеются близко к типу или аналогично, но во множественном числе
grapes = New AGrape[]
apples = New List
или добавлением типа стуктуры в имя переменной.
applesList = New List
Константы - все в верхнем регистре, даже если это фактически переменные, которые выполняют функции констант:
ERROR_CODE_VALID
Именование параметров в функции и методы начинаются со знака подчеркивания _:
function DoSomethingWithFile(_sourceFile: File)
Это позволяет разделить визуально переменные класса, локальные переменные и входные параметры. Близкие по написанию.
Нет пока разделения в именовании локальных, глобальных и переменных классов.
Цель таких пассов - превращение исходного текста в более человеко-читаемый. Что довольно не простая задача, ибо постоянно скатываешься в программисткий стиль.
Имя класса - существительное с неопределённым артиклем:
AClassName
Методы класса и функции - начинаются с глагола и с большой буквы:
DoSomething()
Переменные и поля с маленькой буквы первое слово-существительное-описательное. Остальные слова с большой буквы:
flagUpdate = True
Экземпляры класса могут быть определённым артиклем или без оного, как больше нравится.
TheClassInstance = New AClassName()
Переменные обозначающие массивы, списки, мапы и т.п., т.е. те которые содержат множество элементов одного типа имеются близко к типу или аналогично, но во множественном числе
grapes = New AGrape[]
apples = New List
или добавлением типа стуктуры в имя переменной.
applesList = New List
Константы - все в верхнем регистре, даже если это фактически переменные, которые выполняют функции констант:
ERROR_CODE_VALID
Именование параметров в функции и методы начинаются со знака подчеркивания _:
function DoSomethingWithFile(_sourceFile: File)
Это позволяет разделить визуально переменные класса, локальные переменные и входные параметры. Близкие по написанию.
Нет пока разделения в именовании локальных, глобальных и переменных классов.
Цель таких пассов - превращение исходного текста в более человеко-читаемый. Что довольно не простая задача, ибо постоянно скатываешься в программисткий стиль.
No comments:
Post a Comment