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

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

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

Odin_KG
платная, ищу алтернативу. Если не найду буду её пользоваться, но мне по сути кроме как текста и тега "Код C|C++" как в форуме больше ничего не надо

#16
22:54, 31 янв 2015

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

думаю вполне хватит настроенных проектов с решением типовых задач, нормальными комментариями и предложениями по доработке

если времени вообще немерянно можно заюзать вики для документирования особо сложных конструкций :)

#17
22:57, 31 янв 2015

IROV..
> платная, ищу алтернативу.
В принципе, я тебе финальную версию справки могу у себя собрать - у меня лицензия куплена.

>мне по сути кроме как текста и тега "Код C|C++" как в форуме больше ничего не надо
Иногда это только так кажется. Вот, например, нужно поменять ID у топика, так эта программа автоматически во всем проекте ссылки поменяет на этот топик. Ошибки в тексте проверяются - опять же полезно очень. Вообще я последней версией очень доволен. Да и экспорт в кучу всяких форматов помимо CHM.

#18
0:02, 1 фев 2015

Markdown же. Под оформление кода в самый раз... И в pdf потом перегнать можно (да и во много чего еще). Скачиваешь себе Atom, в нем редактируешь, там и предпросмотр есть -> профит.

#19
0:37, 1 фев 2015

monolit
мне нужен мануал, дока по библиотеке а не "документирование кода" :)

#20
3:18, 1 фев 2015

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

#21
5:46, 1 фев 2015

Zab
> Избаловали нас хорошей документацией от микрософта...
На самом деле, хорошая документация нужна в первую очередь разработчику, а не пользователю. Потому что плохая документация отпугивает пользователей, а те, кто не испугался, задолбают разработчика "наводящими вопросами". Короче говоря, с плохой справкой ты заколебешься саппорт обеспечивать. Хотя... можно, конечно, на всё забить и никому не отвечать, но тогда можно сразу и либу не делать.

Zab
> Проблему вижу, как прикрепить документацию к проекту.
Дык, кладешь в один архив и либу и документацию и, собственно, всё.

#22
12:53, 1 фев 2015

Так Markdown  и не относится к документированию кода... Это самая что ни на есть документация, причем довольно приятная на вид.

#23
13:03, 1 фев 2015

monolit
что то я не могу разобраться как им пользоваться.

что я понял, открываю нотепад++ пишу в формате markdown потом натравливаю "чтото" и получаю html
так вот "чтото" это что?

#24
17:23, 1 фев 2015

Простейший вариант - скачиваешь Atom (сам по себе отличный редактор), создаешь .md файл и редактируешь в нем. Чтобы просмотреть, как все это выглядит, нажимаешь Packages -> Markdown Preview -> Toggle Preview. Все, с одной стороны у тебя исходник, с другой - как этот документ выглядит. Изменения происходят 'на лету'. После создания можно этот .md файл конвертировать и в html, и в pdf (я предпочитаю pdf). Конвертеров в сети достаточно...

Некоторые полезные ссылки:

+ Показать
#25
17:45, 1 фев 2015

monolit
что-то не могу найти как форматирование кода, или он не поддерживает это?

вопрос снят: ``` - три тильды)
не все так просто, Atom подсвечивает, а вот "принтеры"

http://www.markdowntopdf.com/

говорят "иди ка ты отсюда"

#26
19:25, 1 фев 2015

MarkdownPad оффлайновый редактор, вроде достаточно популярный. Правда в pdf там только платная версия может... А в html - пожалста. Или можно схитрить и напечатать файл pdf-принтером)

#27
21:03, 1 фев 2015

baga
> думаю вполне хватит настроенных проектов с решением типовых задач, нормальными комментариями и предложениями по доработке

Выдумывать (и настраивать под разные IDE) некие туториальные проекты - трудозатратно для производителя либы и неудобно для пользователя.
Мне как пользователю нужен именно пример, "как это делается". Как минимум, для того чтобы принять решение, вообще стоит юзать данную либу или нет.
Без трат времени на скачивание/устанавку/настройку и реверс-инжиниринг "обучающих" проектов.
Кроме того, такие проекты - как правило каша из всех разных фич, а мне к примеру в данный момент нужна одна, конкретная.

Чего не хватает - это живых человеческих слов и неизбыточных примеров.

p.s. Докогенераторы (при наличии в современных IDE Класс-браузеров и Интеллисенсов) считаю ненужными.

#28
21:34, 1 фев 2015

monolit
так а что делать с подсветкой в этом md?

#29
9:30, 2 фев 2015

IROV..
> но мне по сути кроме как текста и тега "Код C|C++" как в форуме больше ничего
> не надо
Так это все можно делать, в Word! Когда-то давно, когда еще не было html справки, а обычные вендовые .hlp файлы нужно было компилить специальным компилятором из специально подготовленных rtf файлов - я наколбасил на VBA макросы в ворде, которые делали все что нужно: форматирование, ссылки, загловки, навигацию и прочую мутотень. Дело пары тройки дней.

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

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