caxapa.ru :: Интересует кто как оформляет свои исходники. "Шапка" - копирайт ревизия и прочее. Поделитесь опытом :)

Ruslan (26.10.2007 11:33, просмотров: 23570) Evgeny_CD

Интересует кто как оформляет свои исходники. "Шапка" - копирайт ревизия и прочее. Поделитесь опытом :)

- У дяди Билли, слыхал, мол плотють за каждую строчку (кода или нет) ;) Vit(238 знак., 29.10.2007 09:16)
  - можт там "скрытые" дефайны были - видел такой чудо код - Gamma SPb(29.10.2007 09:40)
- doxygen-стиль bialix_(128 знак., 26.10.2007 16:39)
- Никто ничего путного не написал. Значит все сидят и по названию файла пытаются вспомнить а что тут вообще написанно то ? :)) - Ruslan(26.10.2007 14:54)
  - Лень погуглить, что ли? Я для своего отдела выбрал такой стандарт кодирования и прошу оформлять код по нему. VVB(31 знак., 26.10.2007 15:07, ссылка)
    - Раз вы следуете этим рекомендациям, объясните смысл "Only use C style comments (i.e. /* and */) and not the C++ style comments (i.e. //)". Я наоборот стараюсь использовать //, ибо кусок кода с такими комментами легко закоментировать при помощи Сергей Борщ(206 знак., 02.11.2007 01:13)
      - Это требование к uCOS из-за того, что // комментарии не допускаются стандартом Си, и к uCOS её автор предъявляет требования максимальной унифицированности и возможности работы в старых компиляторах. VVB(710 знак., 02.11.2007 07:42)
        
        Ну и ещё один момент. VVB(345 знак., 02.11.2007 10:51)
        
        Спасибо, прояснилось. Насчет комментов по поводу закомментированого кода - интересно, приму на вооружение. - Сергей Борщ(02.11.2007 22:49)
        
        золотые слова! я как-то переводил хорошую статью по этому поводу. - bialix(02.11.2007 21:52, ссылка)
        
        Согласен по всем пунктам. Главное - "единообразие и аккуратность". - Алексей Мусин(02.11.2007 09:40)
      - +1. Я тоже пробовал использовать только /*, */ для комментариев. Пришел к такому же выводу - неудобно по указанной Сергеем причине. - rezident(02.11.2007 04:01)
        
        Кстати, в качестве отступов предпочитаю два пробела, а не 4. И стараюсь, чтобы исходник по ширине (вместе с комментарием) не выходил за границу 80 символов. - rezident(02.11.2007 04:07)
  - Тут наклевывалось хорошее обсуждение организации исходников и контроля версий, а вы с глупостями лезете :) Алексей Мусин(480 знак., 26.10.2007 15:02)
    - Спасибо. Ладно хоть завелись, на обсуждение :) - Ruslan(26.10.2007 17:39)
- И желательно вместе с остальным исходником :) Алексей Мусин(85 знак., 26.10.2007 11:36)
  - Можно по подробнее про теги? Используем SVN. - Ruslan(26.10.2007 11:53)
    - SubWCRev в документации ищите. В двух словах создается файлег, в котором описаны ключевые слова Gamma SPb(228 знак., 26.10.2007 11:58)
    - RTFM Алексей Мусин(33 знак., 26.10.2007 11:55)
      - как, вы все еще кипятите? а мы уже рубим! - bialix_(26.10.2007 16:42)
  - ИМХО в заголовок все равно смысла нет, всегда можно посмотреть какая ревизия лежит в рабочей копии. А вот констовую строку с номером ревизии в код вставить полезно. Даже очень - Gamma SPb(26.10.2007 11:38)
    - И выводить по всем интерфейсам (при запуске по отладочному UART, например, и по рабочему куда-нибудь -- для ЗНАЧИТЕЛЬНОГО облегчения жизни) - VVB(26.10.2007 11:47)
      - "И выводить по всем интерфейсам " :) так и делаю. - Ruslan(26.10.2007 12:04)
      - Зачем? По номеру версии ПО однозначно определяются номера версий компонентов (ревизий исходных файлов). - Алексей Мусин(26.10.2007 12:02)
        
        Включаешь собранный прибор (один из 5), смотришь на номер версии, чешешь затылок, разбираешь и перешиваешь. Или работаешь. Имеется в виду облегчение в процессе разработки. - VVB(26.10.2007 12:05)
        
        В чем облегчение? Может, я чего-то не так делаю Алексей Мусин(211 знак., 26.10.2007 12:21)
        
        Немного о разных вещах говорим. Я говорю о разработке, где в приборе обычно должна быть зашита самая последняя версия. VVB(650 знак., 26.10.2007 12:47)
        
        да щаз. библиотеки не используете? - Gamma SPb(26.10.2007 12:04)
        
        Разжуйте пож-та, а то непонятно, как сочетается "библиотека" и "строку... в код вставить". - Алексей Мусин(26.10.2007 12:18)
        
        мы не так друг друга поняли =) я имею в виду, что ревизия проекта и ревизии библиотек, которые там используются (rtos, например, обслуживание ЖКИ и т.п.) - это разные вещи и храняться они в разных ветках. - Gamma SPb(26.10.2007 12:32)
        
        Вопрос идентификации ПО, по-моему, стоит решать иными способами, а не записью версий "библиотек" в ПЗУ и последующим выводом в терминал етц. Алексей Мусин(375 знак., 26.10.2007 14:32)
        
        А на мой аналогичный вопрос есть ответ, что рабочую копию библиотек можно включить в проект. - Vladimir Ljaschko(26.10.2007 12:40)
- самое смешное, что кроме эстетического удовлетворения от этого никакой пользы =) - Gamma SPb(26.10.2007 11:35)
  - Да по моему эти шапки - вред сплошной, внимание рассеивается. - Vladimir Ljaschko(26.10.2007 11:48)
    - И камменты туда же, в топку? :) - Алексей Мусин(26.10.2007 11:54)
      - Ну да... :) Правда, лишние удаляю. - Vladimir Ljaschko(26.10.2007 12:21)
    - Ну почему же? Если взять в привычку писать в шапку дату и то что сделал то очень полезно. - Ruslan(26.10.2007 11:52)
  - Что посеешь... Можно описать работу данного программного модуля с "илююстрациями" - блок-схемой, параметрами и т.д. - Алексей Мусин(26.10.2007 11:39)

Средства и методы разработки