Помощь - Поиск - Пользователи - Календарь
Полная версия этой страницы: Систематизация программной документации
Форум разработчиков электроники ELECTRONIX.ru > Cистемный уровень проектирования > Документация
MrYuran
Вроде такая тема проскакивала как-то, попробую ещё раз.
Задача такая:
Нужно ввести в конторе какой-то единый образец (или стандарт) написания исходников.
Не так жёстко, что "комментарии только блоками и никак иначе" или определение функции, отформатированное с точностью до пробела, а скорее на структурном, системном уровне, например, как делить проект на модули, что выносить в h-файл, рекомендации по функциональному делению и т.д.

Желательно при этом подходить с т.з. рационального программирования, то есть удобно должно быть не только человеку, читающему код, но и компилятору, оптимизирующему его. На подсознательном уровне вроде всё понятно, но родить документ с ходу не получается.

В конторе 3-4 программиста (я в их числе), у каждого свой неповторимый "стиль".
Попытка что-то обсудить ни к чему не приводит (никто не хочет переделывать свою работу под чужой шаблон)

В общем, решили пока вносить конкретные предложения и рассматривать их по отдельности.

Может, есть у кого подобные рекомендации по оформлению именно структуры кода? (синтаксиса и прочих мелочей пока не касаемся)

Ну и вообще, кидайте что есть (если не секретно или дсп, конечно)

Ещё в связи с плавным перетеканием с IAR на GCC есть мысль писать кросскомпилируемые проекты. То есть в mspgcc есть файл isr_compat.h, с помощью которого унифицируются описания прерываний, думаю что-то подобное написать для остальных нюансов.
dissector
Дайте прогерам почитать статью Автоматное программирование для начинающих. Все детально, на пальцах, с примером. Есть и ссылки на гуру в части автоматного программирования. Забудете обо всем на свете, включая проблемы с кодами smile.gif
altlogic
MrYuran: вы разработали документ? Я иду дальше, готовлю документ по оформлению программ на языке Си, где будет указано даже то, где надо ставить скобочки. Недавно обратил внимание, что сам придерживаюсь вполне определённого стиля оформления кода, который по мнению некоторых профессиональных программистов не очень читаем. Задумался...
des00
Цитата(MrYuran @ Jan 28 2009, 02:12) *
Ну и вообще, кидайте что есть (если не секретно или дсп, конечно)



Макконел «Совершенный код. Практическое руководство по разработке программного обеспечения»

Соглашения по оформлению кода команды RSDN
_Pasha
Цитата(altlogic @ May 14 2009, 14:57) *
Я иду дальше, готовлю документ по оформлению программ на языке Си, где будет указано даже то, где надо ставить скобочки.

А использовать утилиту Astyle религия не позволяет? Дайте кодовым форматтерам делать свое дело, вместо того, чтобы издавать бессмысленные законы
Для просмотра полной версии этой страницы, пожалуйста, пройдите по ссылке.
Invision Power Board © 2001-2025 Invision Power Services, Inc.