Войти
ПрограммированиеФорумОбщее

документация библиотеки (3 стр)

Страницы: 1 2 3
#30
11:51, 2 фев 2015

А что мешает добавить документацию в код?
Это полезно в любом случае, а лучше doxygen+шкурки особо ничего не придумано (https://ru.wikipedia.org/wiki/Категория:Свободные_генераторы_документации).

#31
12:22, 2 фев 2015

В LibreOffice имеется Code Colorizer Formatter.

#32
12:29, 2 фев 2015

Kashey
Привет, давно не виделись)
Я вообще яростный адепт не документирования кода)) Но хочу сделать мануал (pdf) с описанием как ею пользоваться и примерами. Что всегда считаю полезней чем описание и так очевидных всем вещей

#33
15:01, 3 фев 2015

IROV..
есть там форматирование. Пример:

```c++
int main() {
    return 0;
}
```

А про doxygen тебе правильно говорят, прислушайся... Очевидные для тебя вещи могут показаться далеко не очевидными для других (конечно, я не имею ввиду, к примеру, функции типа setX, getX - и так ясно, в целом, что они делают=)).  Описание параметров функции, что она делает, и какие исключения бросает (если бросает) - полезная штука. А в pdf лучше описывать что-то более ... хм, весомое - как лучше пользоваться тем-то, какие лучше задать параметры там-то и т.п.

#34
15:09, 3 фев 2015

monolit
я нашел, теперь ищу принтер в pdf который понимает ''' а то это я так понял не родное расширение.

>>А про doxygen тебе правильно говорят, прислушайся... Очевидные для тебя вещи могут показаться далеко не очевидными для других (конечно, я не имею ввиду, к примеру, функции >>типа setX, getX - и так ясно, в целом, что они делают=)). Описание параметров функции, что она делает, и какие исключения бросает (если бросает) - полезная штука.
Возможно только для этого и будет

отдельно API отдельно Мануал

#35
17:15, 5 фев 2015

IROV..
Вот если это API - то мануал должен быть в коде, в том числе версионироватся вместе с кодом.
А когда он существует параллельно - это не всегда возможно.
Тут другой вопрос - а много ли доки? А то есть у меня одно АПИ, достаточно большое, с одной публичной задокументированной функцией.

Страницы: 1 2 3
ПрограммированиеФорумОбщее

Тема в архиве.