Соглашение об оформлении кода
Drake
"правильности" оформления кода.
Выработав соглашение об оформлении, мы все упростим себе жизнь.
Начнём с того, что каждый из нас перечислит свои привычки отдельным
сообщением.
Vladimir
Drake
Имена
Имя не может начинаться с символа <<_>>.
Сокращения -- зло, за исключением общепринятых аббревиатур. Во всех
случаях лучше стараться давать максимально подробные имена переменным,
методам и классам.
Не стоит использовать венгерскую нотацию, добавляя упоминание о
типе в имя переменной. Среда всегда подскажет тип, плюс, строгая
типизация не позволит спутать переменные разных типов.
Переменные именуются строчными буквами, элементы имени переменной
разделяются символом <<_>>.
Имя класса получает префикс, как правило, T. Таким образом, название
класса складывается из описательного названия (например, Table) и
префикса (то есть TTable). Использование префикса позволяет четко
разграничить все случаи использования класса и объекта.
Члены классов именуются в Camel Case, причем - поля в Upper Camel
Case, методы - в Lower Camel Case. Не допускается разделение элементов
имени члена класса какими бы то ни было символами.
Переменные
Всякий раз, когда вы используете глобальную переменную - умирает
котёнок.
Всякий раз, когда вы используете #DEFINE для определения константы -
умирает котёнок.
Глобальные переменные и константы можно и нужно объявлять либо через
статические члены класса, либо через enum. Это упрощает систему
именования в коде, и позволяет упростить процедуру отладки, уменьшает
вероятность конфликтов имён. Оставим дефайны для условной компиляции.
Блоки
С блоками всё очень просто - используй их всегда, даже для
однострочных обработчиков условий. Даже для однострочных форов.
Всегда. Правило без исключения проще запомнить.
Drake
и прочих элементов бд.
Напрягает переключать кодировку. Напрягает гадать, что мне там пгадмин
говорит непонятным набором символов.
Vladimir
наименований - от них можно избавиться, когда мы полностью устраним
зависимость кода ядра от БД, т.е. когда все же выделим всю работу с БД
в отдельный модуль.
Vladimir
транслировать имена таблиц и столбцов из какого-то условного названия
в ядре в конкретное название, которое используется на сервере с тем,
чтобы мы потом легко могли поменять наименования таблиц, просмотров и
их столбцов (и функцию в ядре, либо загрузить таблицу трансляции и
сервера), а ядро об этом даже и не знало. Русскоязычный вариант
предлагаю оставить как альтернативу, может кому-нибудь потом он
понадобится.
Drake
сейчас сгодится, что есть.