Digital Book. Книга вторая

Может быть, когда-нибудь, программирование, так и стили программирования и правила, будут заноситься в ДНК или зашиваться куда-то на подкорку, а пока этого не произошло, попробуйте в своей компании выстроить преемственность программного кода и вы увидите, как люди перестанут изобретать велосипед, писать заново одни и те же библиотеки и методы.

Сами Правила должны быть для каждого языка и для каждой системы свои. Вам не удастся создать общие для всех Правила, ну и это бессмысленно.

Сами Правила можно разделить на 2 типа:

1. Code Standards – правила построения алгоритмов и использования переменных и тд):

? длина идентификаторов и переменных

? какие имена можно назначать переменным – используют только смыслово значимые переменные, например Age вместо a73fsfBd для хранения возраста

? регистра букв и цифры – например некоторые языки чувствительные к регистрам, т. е. переменные Age и AGE будут восприняты, как разные.

? правила использования спец. символом – тут они тоже есть, это всякие /? и другие

? слова, разделенные буквами, – AgeOfEmpires итд

? правила формирования типов переменных – каким значениям можно присвоить логические типы, а каким числовые. Например, когда присваивать логический тип boolean, а когда числовой

? когда переменная должна быть глобальной и доступа другим модулям и библиотекам

? какие проверки нужно делать в коде, чтобы избежать уязвимостей в кодей, таких как XSS, SQL инъекции и т.

д. Например, брать любой код в кавычки или круглые скобки, если он не был сгенерен вашей программой

? наличие комментариев и аннотаций

? какие внешние библиотеки являются общими и обязательными

? согласованность в коде и приложениях

? обработка исключений и ошибок

? принципы объявления переменных (не объявляйте переменные, если не используете, не забывайте закрывать переменные)

2.

 Code Style – это непосредственно правила написания кода, т. е. стиль. Если проще сказать, то это правило, когда вы ставите в коде кавычки и когда их закрываете. Это называется конструкция. Например, размер отступа или структура кода. Еще в школе и университете меня учили, что у кода должна быть структура. Самой машине все равно, как его читать, а вот человеку нет.