YP
Нагляднее будет просто написать большой кусок текста. Без жёсткой привязки к коду
Size: a a a
2019 October 30
V
когда последний раз копал на эту тему остановился на sphinx, но пока не запилил у себя
ML
Yuri Pipchenko
Такими тулами можно только смысл функций/параметров описать. Если код близок к функциональному стилю, то такое описание практически ничего не поясняет.
Ничего не понял, причем тут функциональный стиль?
V
но это скорее для более высокоуровневой документации
YP
Ничего не понял, причем тут функциональный стиль?
Ну, если код оформлен небольшими чистыми функциями, то комментарий предназначения каждой из них слабо раскроет общий смысл модуля.
V
можно глянуть как https://github.com/Pyrlang/Pyrlang сделан, тоже его использует для erlanga и python
2019 October 31
ML
Yuri Pipchenko
Ну, если код оформлен небольшими чистыми функциями, то комментарий предназначения каждой из них слабо раскроет общий смысл модуля.
Если код оформлен небольшими чистыми функциями, то его мало и он примитивный
AB
Я чет не верю в автодокументацию, по мне так лучше .md с человеческим описанием класть рядом с кодом, или вики
AB
Эти теги ещё и код замусоривают
В
Маркдаун - тоже себе из разряда древнегреческих форматов. А вот edoc -> asciidoc было бы интересно
СИ
Alexander Bogosyan
Я чет не верю в автодокументацию, по мне так лучше .md с человеческим описанием класть рядом с кодом, или вики
Ну erldoc же работает. И вообще otp дока. Другое дело что там авторам английский не родной и мне со школьным английским туго
VS
я слегка подправленным
подправил его на использование
Разметку и
диаграммы рисую в тексте через
README.md конвертирую из
asciiedoc_doclet пользуюсь,подправил его на использование
asciidoctor сasciidoctor-diagram.Разметку и
overview пишу в asciidoc, диаграммы рисую в тексте через
PlantUML или ditaa.README.md конвертирую из
overview через pandocML
я слегка подправленным
подправил его на использование
Разметку и
диаграммы рисую в тексте через
README.md конвертирую из
asciiedoc_doclet пользуюсь,подправил его на использование
asciidoctor сasciidoctor-diagram.Разметку и
overview пишу в asciidoc, диаграммы рисую в тексте через
PlantUML или ditaa.README.md конвертирую из
overview через pandocAsciidoc - это что-то покруче маркдауна?
VS
не сравнимо, мощность как у reStructuredText,
а простота как у markdown
а простота как у markdown
ML
не сравнимо, мощность как у reStructuredText,
а простота как у markdown
а простота как у markdown
А rest прям крут?
ML
Короче, стоит посмотреть?
VS
дело вкуса, конечно, но rest на мой взгляд сильно усложнен,
никогда не мог запомнить надолго всех его конструкций,
кроме sphinx ничего приемлемого для работы с ним не знаю,
а он питоноориентирован, что неудобно и транслятор
в pdf просто дрянь, особенно форматирование таблиц,
приходилось вручную вставлять latex.
С asciidoc таких головных болей у меня нет.
никогда не мог запомнить надолго всех его конструкций,
кроме sphinx ничего приемлемого для работы с ним не знаю,
а он питоноориентирован, что неудобно и транслятор
в pdf просто дрянь, особенно форматирование таблиц,
приходилось вручную вставлять latex.
С asciidoc таких головных болей у меня нет.
V
эмм erlang domain у него не рабочий?
В
Asciidoc - это что-то покруче маркдауна?
Однозначно
V
хм ок вижу он для 1.0 версии сфинкса