Правила оформления кода
Правила оформления кода
-
Наличие единых правил оформления кода является одним из технологических аспектов сплочения коллектива и повышения эффективности поддержки разработок.
- В отделе разработка ведется на двух языках программирования: С++ и Java.
При написании кода разработчики,как правило, придерживаются одного из двух подходов относительно форматирования своего кода. Первый заключается в соблюдении правил оформления кода, принятых в том языке программирования или среде разработки, с которыми работает разработчик. Второй подход напротив, подразумевает единообразное оформление кода вне зависимости от внешних условий. Нам больше нравится первый подход. - Как таковые, рекомендации по оформлению кода существовали в отделе примерно с 2010 года. Применительно к языку C++ это был Google Code Style Guide C++. Программируя на Java, мы старались следовать Sun's Java Code Conventions (1997).
- В 2013 году мы существенно обновили наше видение и утвердили собственные правила оформления кода на языке C++. В основу этого документа легла статья «90 рекомендаций по стилю написания программ на C++». Разработанный документ был предоставлен нашим основным разработчикам для изучения. Они его прочитали и внесли свои правки. Окончательная редакция правил была принята на совещании.
Большинство правил естественны и соблюдаются всеми «по умолчанию». К самым спорным традиционно относятся следующие:
- Использование именованных констант должно быть сведено к минимуму — вместо них следует использовать enum.
- Аббревиатуры и сокращения в именах должны записываться в нижнем регистре.
- Все имена следует записывать по английски, транслитерация не допускается.
-
В предметной области, с которой нам приходится работать, зачастую трудно правильно подобрать понятие из английского языка. Приходится составлять свой словарь.
- Следует избегать сокращений в именах.
- Приведение типов всегда должно быть явным. Для приведения типов следует использовать средства, предусмотренные языком С++. Нельзя использовать приведение в стиле С.
- Открывающая скобка в той же строке, что и оператор или на следующей строке без отступа.
- Комментарии следует оформлять в соответствии с соглашениями Doxygen.
-
-
Аналогичная работа сейчас выполняется для языка Java.