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

документация библиотеки

Страницы: 1 2 3 Следующая »
#0
16:57, 31 янв 2015

Добрый день, есть библиотека на С++
хочу написать к ней документацию, и поделиться  с человечеством :)
Но не могу найти хорошую программу для этого.
Подскажите.

#1
17:07, 31 янв 2015

https://ru.wikipedia.org/wiki/Doxygen

#2
17:21, 31 янв 2015

Kartonagnick
он делает на основе исходного кода, код не документирован. нужно что-то отдельное-внешнее

#3
17:53, 31 янв 2015

IROV..

Sphinx (restructured text), markdown, asciidoc, тысячи их.

#4
18:28, 31 янв 2015

Ghost2
я понимаю а что ни будь удобное и простое, из популярного

#5
19:19, 31 янв 2015

Вот эта, на мой взгляд, очень хорошая: http://www.helpandmanual.com/ Но... она платная. На торрентах, естественно, валяется взломанный вариант.

#6
19:23, 31 янв 2015

IROV..
> он делает на основе исходного кода, код не документирован.
Да даже если и документирован, ничего хорошего из этого не получается. Там образуется свалка из списка классов и функций, между которыми логика весьма туманна, а людям нужно, чтобы было описано на человеческом языке. На мой взгляд, хороший пример - MSDN.

#7
19:28, 31 янв 2015

Odin_KG
> Там образуется свалка из списка классов и функций, между которыми логика весьма
> туманна, а людям нужно, чтобы было описано на человеческом языке.

это смотря как делать.
Так то можно сделать и так, что он картинки с диаграммами классов нарисует, и с примерами использования.

#8
20:41, 31 янв 2015

Kartonagnick
я не вижу смысла смешивать мух и котлет, терпеть не могу код, где от функции к функции нужно 3 листа доки проскролить.

#9
21:14, 31 янв 2015

Я обычно сажусь и пишу в формате javadoc-a комментарии в коде, прогоняю потом через doxygen и получаю свою документацию

#10
21:20, 31 янв 2015

MarkoPolo
> Я обычно сажусь и пишу в формате javadoc
ну это же тоже идет в самом коде

мне бы хотелось наверное что-то из разряда форумного сообщения в pdf - пока что остановился на гугл-док, но хочется что-то по специализированей

#11
21:41, 31 янв 2015

IROV..
> я не вижу смысла смешивать мух и котлет, терпеть не могу код, где от функции к
> функции нужно 3 листа доки проскролить.

могу вам только посочувствовать.
Так то я ни разу с подобным не сталкивался. Обычно краткое описание что делает функция, и краткое описание чем являются её параметры.

#12
22:24, 31 янв 2015

Генераторы доков по коду это прикол какой-то, раковая опухоль множества проектов. Зачем мне смотреть гигабайты html если тоже самое есть в хидерах. Лучше сделать понятные примеры как использовать либу.

#13
22:41, 31 янв 2015

baga
> Лучше сделать понятные примеры как использовать либу.
вот это я и хочу сделать. ищу где это лучше делать.

#14
22:48, 31 янв 2015

IROV..
> ищу где это лучше делать.
А чем тебя эта штука не устраивает: http://www.helpandmanual.com/ ?

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

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