Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате
Форум программистов > Общие вопросы по .NET и C# > Автодокуметирование на XML


Автор: Хоббит 11.3.2006, 11:53
Кто с такой фигней работал, подскажите, где почитать на русском про нее можно.
И вообще как XML комнтарии в VS 2005 скомпелировать

Автор: Exception 11.3.2006, 12:25
По-моему, в MSDN всё написано предельно понятно. А комменты, они же автоматически компилируются.. Именно компилируются, а не компелируются.

Автор: mr.DUDA 11.3.2006, 13:25
Цитата(Хоббит @ 11.3.2006, 10:53 Найти цитируемый пост)
И вообще как XML комнтарии в VS 2005 скомпелировать

Компилировать придётся в NDoc, 2005-я студия этого не умеет, она только создаёт XML-файлы по комментариям.

Автор: Exception 11.3.2006, 13:52
Он вроде и по возможностям лучше, чем 2003-я студия..

Автор: Хоббит 11.3.2006, 15:58
.... мм .... читаю книжку по 2003 кажется ... нажмите Tools Build Component Web Page ... и появляется такая красивая инструкция по твоей программе ... (по твоим XML коментариям)

Кто нибудь может сказать как тоже сделать в 2005 .... коментарии написал ... как теперь мне такой же результат увидеть .... а то загодочные слова
NDoc мне ничего не говорят

Автор: mr.DUDA 11.3.2006, 17:22
Цитата(Хоббит @ 11.3.2006, 14:58 Найти цитируемый пост)
Кто нибудь может сказать как тоже сделать в 2005 .... коментарии написал ... как теперь мне такой же результат увидеть .... а то загодочные слова
NDoc мне ничего не говорят

Скачиваем и устанавливаем то что находится по http://prdownloads.sourceforge.net/ndoc/NDoc-v1.3.1.msi?download, запускаем. При этом требуется наличие .NET Framework 1.1; если на машине установлен Framework 2.0, тогда качаем http://ndoc.sourceforge.net/ndoc-nightly.zip, распаковываем, открываем в студии и компилируем. В 2005-й студии один плагин не компилируется без MS Help SDK, но это не страшно; всё остальное работает замечательно.

Запускаем NDocGui.exe (если собирали сами - то exe'шник лежит в директории "ndoc\src\Gui\bin\Debug\").

Окно программы состоит из двух частей: вверху список документируемых сборок, внизу - настройки проекта. Настройки можем не менять, а в список длл-ок добавляем свои DLL/EXE. Нажимаем кнопку Build documentation, и через минуту/полторы получаем готовый .CHM-файл с документацией в стиле MSDN в директории "doc".

Естественно, что хотя бы минимальные комменты должны быть в коде, и в настройках проекта нужно поставить галку "XML Documentation File:".

P.S.
я приаттачил сюда ZIP с скомпилированным NDoc'ом для .NET Framework 2.0, так что если лень качать 1,7-мегабайтный архив и компилировать самому - милости просим на готовое smile

Автор: Хоббит 11.3.2006, 18:52
спасибо Добрый человек

Автор: mr.DUDA 11.3.2006, 19:13
You welcome.

Автор: eisernWolf 12.3.2006, 23:48
См. также GhostDoc.

Автор: Хоббит 22.5.2006, 14:59
mr.DUDA 

VS Solution Import Warnings

There are no projects in this solution that NDoc can import.

Either the solution is blank, or the projects contained within
the solution are not of a type NDoc can import.
 ... 

такую вешь возращает, скомпилированный тобой Ndoc при открытии любого солющена ...
VS2005 Framework 2.0 

Автор: kulibin 22.5.2006, 15:13
чёто я не сильно понял почему вы считаете, что студия 2005 не может документацию делать. я пробовал когдато - вроде получалось. там опции в свойствах проекта задаются вроде на вкладке билд. как-то так - точно не помню. и создаётся документация по xml-комментам в тексте программы. причём документация и в виде html тоже вроде - если меня склироз не подводит. токо сам я не очень с тэгами теми разобрался и забросил это дело. но планирую всёже к нему вернуться когда время будет. 

Автор: Хоббит 22.5.2006, 20:39
 smile  smile  smile  smile  smile  smile  smile ... smile ... точный адресс пожалуйста 

Автор: mr.DUDA 23.5.2006, 11:03
Хоббит, чтобы скомпилить документацию, лично я добавляю длл-ки (из которых компилится CHM-документ) руками, импортировать солюшен не пробовал, но с уверенностью можно сказать что старый NDoc понятия не имеет о студии 2005.  

Автор: Pankon 23.5.2006, 14:26
Цитата(mr.DUDA @  11.3.2006,  17:22 Найти цитируемый пост)
милости просим на готовое


MSDN Project

Код

An error occured while trying to build the documentation.

Exception: NDoc.Core.DocumenterException
Error compiling the namespace stylesheet

Exception: System.Exception
Error compiling the namespace stylesheet
....
Documenter\Msdn\xslt\namespace.xslt 
не найден


 smile 
 

Автор: Хоббит 24.5.2006, 22:30
та же шняга, даже когда dll скармливаю 

Автор: mr.DUDA 26.5.2006, 12:30
И у меня не работает тож, хотя когда заливал - работало smile

Покопавшись в гугле, нашёл рабочий ссылко NDoc для .NET 2.0 - вот оно:
http://www.vehemence.org.uk/files/ndoc/ndoc-bin-1.3.1-v13.zip 

Автор: Pankon 26.5.2006, 13:16
Цитата(mr.DUDA @  26.5.2006,  12:30 Найти цитируемый пост)
вот оно
 - Работает  smile 
 

Автор: maxxim 24.4.2008, 12:58
А как сделать чтоб NDoc еще и русский распознавала?)))

Сорри!) Уже разобрался)))

Powered by Invision Power Board (http://www.invisionboard.com)
© Invision Power Services (http://www.invisionpower.com)