Стандарт кодирования
Стандарт кодирования - набор правил и соглашений, используемых при написании исходного кода на некотором языке программирования [1]. Другие варианты названия: стандарт оформления кода, coding standard, coding convention, programming style, code style guide.
Стандарт оформления кода обычно принимается и используется некоторой группой разработчиков программного обеспечения с целью единообразного оформления совместно используемого кода. Такой стандарт сильно зависит от используемого языка программирования. Например, стандарт оформления кода для языка Си++ будет серьёзно отличаться от стандарта для языка PHP.
Стандарт оформления кода описывает различные аспекты создания и сопровождения исходных текстов программ. В качестве примера, можно перечислить следующие аспекты: правила именования переменных, стиль отступов, способ расстановки скобок, использование пробелов при оформлении арифметических выражений, стиль комментариев и так далее.
Существует достаточно большое количество литературы посвященной рекомендациям в оформлении кода и создании стандартов кодирования. Но в первую очередь хочется выделить две книги: "Совершенный код" [2] и "Веревка достаточной длины, чтобы... выстрелить себе в ногу." [3].
Многие статические анализаторы кода за счет гибкой настройки позволяют осуществить контроль соблюдения стандарта кодирования принятый в компании. В этом случае, предупреждения, выдаваемые статическими анализаторами кода, можно рассматривать не только как диагностику потенциальных ошибок, но и как уведомление о нарушении принятого стандарта кодирования.
Библиографический список
- Wikipedia. Стандарт оформления кода.
- Макконнелл С. Совершенный код. Мастер-класс / Пер. с англ. - М. : Издательско-торговый дом "Русская редакция"; СПб.: Питер, 2005. - 896 стр.: ил. ISBN 5-7502-0064-7.
- Ален И. Голуб. Веревка достаточной длины, чтобы... выстрелить себе в ногу. http://e-maxx.ru/bookz/files/golub_cord.pdf
- Google C++ Style Guide. https://google.github.io/styleguide/cppguide.html
- Geotechnical Software Services. C++ Programming Style Guidelines. http://geosoft.no/development/cppstyle.html
- CERT C++ Secure Coding Standard. https://www.securecoding.cert.org/confluence/pages/viewpage.action?pageId=637
- David Abrahams and Nathan Myers. C++ Coding Guidelines. http://bit.ly/2aym28b
- Mozilla Coding Style Guide. https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style
0