Какие есть средства организации онлайн документирования и просмотра исходного кода (C#)?

Question

[asdz]

Хотелось бы иметь локальный сервер документирования и одновременно просмотра исходного кода наподобие referencesource.microsoft.com/. Чтобы можно было загрузить исходники и по комментариям была сгенерирована документация, где нужно к методам, классам дописать свою документацию. Все это можно было смотреть онлайн через браузер и при необходимости выгрузить в виде документа или файла стравки.

Answer 1

[Эдуард Тибет]

Doxygen?

Первый вариант: по связке: SCM - выгрузка на диск - генерация - web-server. Правда, здесь онлайн документирования не будет - только документирование в коде.

Второй вариант: SCM - выгрузка в docbook - комментарии в XML Editor applet (прямо на сервере) - генерация - web-server. Но опять же с онлайном в чистом виде (как в wiki) не будет - только через выполнение апплета на клиентской машине.

Да, и еще... забыл добавить. Тот ресурс, который вы привели, использует статику. В нем нет возможности обновить онлайн.

Comments

[asdz]

Спасибо. Раньше не сталкивался с такими средствами, посмотрю Doxygen... Но вообще, было бы удобно смотреть документацию и подсматривать в исходный код реализации...

[Эдуард Тибет]

А что вам мешает сделать include исходников внутрь docbook файлов, например? Вот так: https://simonecarletti.com/blog/2009/01/using-xinc... или так (раздел including text): doccookbook.sourceforge.net/html/en/dbc.markup.xin... Т.е. примеры будут "живые" и подтягиваться с диска Только не перестарайтесь и не забудьте следить за актуальностью связки описание- код

[Станислав Макаров]

Эдуард Тибет +1 за DocBook)

[Эдуард Тибет]

asdz , Станислав Макаров
если будут вопросы, то welcome на русскоязычный форум про единый источник: forum.singlesourcing.ru

[asdz]

Эдуард Тибет: Ок, спасибо Эдуард!

Answer 2

[Василий]

Opengrok