Гость
Целевая тема:
Создать новую тему:
Автор:
Форумы / Программирование [игнор отключен] [закрыт для гостей] / Где делать описание кода? / 6 сообщений из 6, страница 1 из 1
12.11.2008, 15:43
    #35649519
GKS_Samara
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Где делать описание кода?
Добрый день!

Вот есть описания классов/методов- это понятно, в JavaDoc.
Есть ТЗ и прочее- это отдельные документы.
А где писать описание, более общее, нежели описание классов, но это именно программная документация? Проектная документация...

Проблема в том, что если это делать в wiki/doc'ах, то при изменении кода поправить документацию обязательно забудут.
А если это писать в коде, то это будет правиться, но что-то в этом не очень хорошее есть...

--
Алексей
Posted via ActualForum NNTP Server 1.4
...
Рейтинг: 0 / 0
12.11.2008, 18:31
    #35650156
egorych
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Где делать описание кода?
GKS_Samara
А если это писать в коде, то это будет правиться, но что-то в этом не очень хорошее есть...
что именно не хорошо?
...
Рейтинг: 0 / 0
12.11.2008, 18:54
    #35650199
mayton
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Где делать описание кода?
GKS_SamaraПроблема в том, что если это делать в wiki/doc'ах, то при изменении кода поправить документацию обязательно забудут.
Ерунда. Общая проектная документация не правится при каждом багофиксе. Если у вас это так то вы её неверно определили.
...
Рейтинг: 0 / 0
12.11.2008, 23:32
    #35650456
tchingiz
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Где делать описание кода?
GKS_Samara,
существую еще пояснительные записки, руководства программиста, руководства системного
программиста, руководства оператора.
на http://en.wikipedia.org/wiki/Doxygen не смотрели?.
...
Рейтинг: 0 / 0
13.11.2008, 12:18
    #35651303
Реалист
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Где делать описание кода?
GKS_Samara,

Пиши так же JavaDoc, но в описаниях для пакетов. (Файл с определенным именем, в котором только описание без кода)
...
Рейтинг: 0 / 0
13.11.2008, 13:48
    #35651631
untitled
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Где делать описание кода?
вики поставить, конклюжен или еще что-то типа того
...
Рейтинг: 0 / 0
Форумы / Программирование [игнор отключен] [закрыт для гостей] / Где делать описание кода? / 6 сообщений из 6, страница 1 из 1
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]