LINUX.ORG.RU

> Представление кода в печатном виде. Что обычно требуется?


0

0

Сейчас обдумываю что следует включить в серию статей по LaTeX для Linux Format. Предварительно решил, что одна из статей будет посвящена оформлению кода. Хотелось бы понять что для представления кода нужно.

Мне лично достаточно просто напечатать код с минимальными "украшательствами", как то подпись, выделение ключевых слов, автоматическая нумерация строк.

Надо ли описывать как рисовать блок схемы программ? Или это излишне? Если надо, то на сколько подробно это описывать? Я как-то не сталкивался с такой необходимостью.

Ну и вообще, что для написания технической документации может быть нужно?

С уважением Евгений

★★★★★

Меня терзают смутные сомнения, что если не знаешь, что писать нужно, то лучше просто не писать или доверить эту статью в серии другому (написать в соавторстве).

anonymous
()

> Надо ли описывать как рисовать блок схемы программ?

Нафиг, ибо metapost рулит.

> Ну и вообще, что для написания технической документации может быть нужно?

документация API системы в стиле doxygen/haddock. программы в целом - {C,F,Funnel,no}WEB и им подобные (lhs2TeX) тут классика TeX: The Program и METAFONT: The Program.

Begemoth ★★★★★
()
Ответ на: комментарий от Begemoth

> TeX: The Program

Как это по русски: "Грамотное программирование" в планах, но боюсь это будет выбиваться из формата :( Да и как-то не очень то распространено Literate Programming.

Evgueni ★★★★★
() автор топика
Ответ на: комментарий от Evgueni

literate programming в переводе 3его издания 1 тома TAOCP предлагается переводить как "грамотное программирование" или "структурное документирование" (лично мне второй варинт больше нравится - "литературное программиорвание" ИМХО больше к жаргонизмам тянет).

> Да и как-то не очень то распространено

зато эффективно. А так уже сказал - doxygen и ему подобные. Документация должна писаться вместе с кодом (в одном файле), она и так имеет тенденцию к устареванию, а если отделена от кода - то еще сильнее.

Begemoth ★★★★★
()
Ответ на: комментарий от Begemoth

> зато эффективно. А так уже сказал - doxygen и ему подобные. Документация должна писаться вместе с кодом (в одном файле), она и так имеет тенденцию к устареванию, а если отделена от кода - то еще сильнее.

Воспринял. Надо будет сделать как минимум врезку. Ещё есть идеи ? :)

Evgueni ★★★★★
() автор топика
Ответ на: комментарий от Begemoth

> literate programming в переводе 3его издания 1 тома TAOCP предлагается переводить как "грамотное программирование" или "структурное документирование" (лично мне второй варинт больше нравится - "литературное программиорвание" ИМХО больше к жаргонизмам тянет).

IMHO "грамотное" для перевода всё-таки лучше, так как со "структурным" могут возникнуть не правильные ассоциации. Литературное - "очевидный" неправильный перевод :)

Evgueni ★★★★★
() автор топика
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.