|
|
|
Где делать описание кода?
|
|||
|---|---|---|---|
|
#18+
Добрый день! Вот есть описания классов/методов- это понятно, в JavaDoc. Есть ТЗ и прочее- это отдельные документы. А где писать описание, более общее, нежели описание классов, но это именно программная документация? Проектная документация... Проблема в том, что если это делать в wiki/doc'ах, то при изменении кода поправить документацию обязательно забудут. А если это писать в коде, то это будет правиться, но что-то в этом не очень хорошее есть... -- Алексей Posted via ActualForum NNTP Server 1.4 ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 12.11.2008, 15:43 |
|
||
|
Где делать описание кода?
|
|||
|---|---|---|---|
|
#18+
GKS_Samara А если это писать в коде, то это будет правиться, но что-то в этом не очень хорошее есть... что именно не хорошо? ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 12.11.2008, 18:31 |
|
||
|
Где делать описание кода?
|
|||
|---|---|---|---|
|
#18+
GKS_SamaraПроблема в том, что если это делать в wiki/doc'ах, то при изменении кода поправить документацию обязательно забудут. Ерунда. Общая проектная документация не правится при каждом багофиксе. Если у вас это так то вы её неверно определили. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 12.11.2008, 18:54 |
|
||
|
Где делать описание кода?
|
|||
|---|---|---|---|
|
#18+
GKS_Samara, существую еще пояснительные записки, руководства программиста, руководства системного программиста, руководства оператора. на http://en.wikipedia.org/wiki/Doxygen не смотрели?. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 12.11.2008, 23:32 |
|
||
|
Где делать описание кода?
|
|||
|---|---|---|---|
|
#18+
GKS_Samara, Пиши так же JavaDoc, но в описаниях для пакетов. (Файл с определенным именем, в котором только описание без кода) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 13.11.2008, 12:18 |
|
||
|
|
start [/forum/topic.php?fid=16&fpage=132&tid=1344855]: |
0ms |
get settings: |
12ms |
get forum list: |
22ms |
check forum access: |
3ms |
check topic access: |
3ms |
track hit: |
52ms |
get topic data: |
102ms |
get forum data: |
3ms |
get page messages: |
98ms |
get tp. blocked users: |
2ms |
| others: | 221ms |
| total: | 518ms |
| 0 / 0 |
