MBR (mbr) wrote,
MBR
mbr

Categories:

Оформление кода

Учитывая, что периодически приходится привлекать фрилансеров для работ, у меня сложился вот такой вот общий принцип оформления кода:

I. Все проекты

1. Отступ — пробелы, размер отступа — 4 пробела
2. Документирование — только английский, по возможности doxygen-совместимое.
3. Typedef, enum, константы оформляются египетскими скобками, все остальное — без них.
4. Magic numbers не должно быть.
5. Все typedef описываются ПРОПИСНЫМИ буквами.
6. Кодировка всех файлов — utf8.
7. Использование венгерской нотации не допускается.

II. С++

1. Стиль — camelCase. Исключение — typedef и константы — under_scope с прописными буквами.
2. Названия классов начинаются с Прописной буквы.
3. Сокрашения в названии НЕ приветствуются.
4. Глобальных переменных и дефайнов не должно быть. За исключением включенного С кода.
5. Для gui использовать Qt. Для приложений без gui стараться воздерживаться от чего либо кроме std.

III. C, Asm

1. Стиль — under_scope. Только строчные буквы. Сокращения рекомендуются и допускаются, если при этом не теряется общий смысл.
2. Константы начинаются с двойного подчеркивания (__) и пишутся ПРОПИСНЫМИ буквами
3. Переменные в define должны быть обернуты в ()
4. Все дефайны пишутся ПРОПИСНЫМИ буквами.
5. Неинтерфейсные функции должны быть статичными.
6. Статичные функции, использованные всего один раз должны быть инлайновыми.

До kernel coding style, конечно, далеко... Но общий стандарт это всегда хорошо. Только просьба писать по-существу, без личных предпочтений.
Tags: it
Subscribe

  • Победил битрикс

    Раньше рассказывал, как мы пытаемся битрикс внедрить. Сначала просто дал задачу вебщику подергать странички и собрать отчет по линкам. Ад. Там…

  • Советский инженер - это звучит гордо

    Порадовался с последнего стеба vladimir_akinin над программистами. Однако в комменты выползло какое-то количество старых пердунов,…

  • В поддержку FSF

    Как многие знают, сейчас в отношении Ричарда Столлмана развернулась травля относительно, якобы, имевших место некорректных его личных высказываний.…

  • Post a new comment

    Error

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 40 comments

  • Победил битрикс

    Раньше рассказывал, как мы пытаемся битрикс внедрить. Сначала просто дал задачу вебщику подергать странички и собрать отчет по линкам. Ад. Там…

  • Советский инженер - это звучит гордо

    Порадовался с последнего стеба vladimir_akinin над программистами. Однако в комменты выползло какое-то количество старых пердунов,…

  • В поддержку FSF

    Как многие знают, сейчас в отношении Ричарда Столлмана развернулась травля относительно, якобы, имевших место некорректных его личных высказываний.…