Модераторы: Partizan, gambit

Поиск:

Ответ в темуСоздание новой темы Создание опроса
> Автодокуметирование на XML 
V
    Опции темы
Хоббит
Дата 11.3.2006, 11:53 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1263
Регистрация: 6.11.2005

Репутация: нет
Всего: 1



Кто с такой фигней работал, подскажите, где почитать на русском про нее можно.
И вообще как XML комнтарии в VS 2005 скомпелировать
PM MAIL   Вверх
Exception
Дата 11.3.2006, 12:25 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
****


Профиль
Группа: Участник Клуба
Сообщений: 4525
Регистрация: 26.12.2004

Репутация: 29
Всего: 186



По-моему, в MSDN всё написано предельно понятно. А комменты, они же автоматически компилируются.. Именно компилируются, а не компелируются.
PM   Вверх
mr.DUDA
Дата 11.3.2006, 13:25 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


3D-маньяк
****


Профиль
Группа: Экс. модератор
Сообщений: 8244
Регистрация: 27.7.2003
Где: город-герой Минск

Репутация: 110
Всего: 232



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

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


--------------------
user posted image
PM MAIL WWW   Вверх
Exception
Дата 11.3.2006, 13:52 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
****


Профиль
Группа: Участник Клуба
Сообщений: 4525
Регистрация: 26.12.2004

Репутация: 29
Всего: 186



Он вроде и по возможностям лучше, чем 2003-я студия..
PM   Вверх
Хоббит
Дата 11.3.2006, 15:58 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1263
Регистрация: 6.11.2005

Репутация: нет
Всего: 1



.... мм .... читаю книжку по 2003 кажется ... нажмите Tools Build Component Web Page ... и появляется такая красивая инструкция по твоей программе ... (по твоим XML коментариям)

Кто нибудь может сказать как тоже сделать в 2005 .... коментарии написал ... как теперь мне такой же результат увидеть .... а то загодочные слова
NDoc мне ничего не говорят
PM MAIL   Вверх
mr.DUDA
Дата 11.3.2006, 17:22 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


3D-маньяк
****


Профиль
Группа: Экс. модератор
Сообщений: 8244
Регистрация: 27.7.2003
Где: город-герой Минск

Репутация: 110
Всего: 232



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

Скачиваем и устанавливаем то что находится по этой ссылке, запускаем. При этом требуется наличие .NET Framework 1.1; если на машине установлен Framework 2.0, тогда качаем этот архив, распаковываем, открываем в студии и компилируем. В 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

Присоединённый файл ( Кол-во скачиваний: 12 )
Присоединённый файл  NDoc.zip 354,18 Kb


--------------------
user posted image
PM MAIL WWW   Вверх
Хоббит
Дата 11.3.2006, 18:52 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1263
Регистрация: 6.11.2005

Репутация: нет
Всего: 1



спасибо Добрый человек
PM MAIL   Вверх
mr.DUDA
Дата 11.3.2006, 19:13 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


3D-маньяк
****


Профиль
Группа: Экс. модератор
Сообщений: 8244
Регистрация: 27.7.2003
Где: город-герой Минск

Репутация: 110
Всего: 232



You welcome.


--------------------
user posted image
PM MAIL WWW   Вверх
eisernWolf
Дата 12.3.2006, 23:48 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Новичок



Профиль
Группа: Участник
Сообщений: 2
Регистрация: 12.3.2006

Репутация: нет
Всего: нет



См. также GhostDoc.
PM MAIL WWW   Вверх
Хоббит
Дата 22.5.2006, 14:59 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1263
Регистрация: 6.11.2005

Репутация: нет
Всего: 1



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 
PM MAIL   Вверх
kulibin
Дата 22.5.2006, 15:13 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Бывалый
*


Профиль
Группа: Участник
Сообщений: 229
Регистрация: 9.5.2005
Где: Украина, Запорожь е

Репутация: нет
Всего: 3



чёто я не сильно понял почему вы считаете, что студия 2005 не может документацию делать. я пробовал когдато - вроде получалось. там опции в свойствах проекта задаются вроде на вкладке билд. как-то так - точно не помню. и создаётся документация по xml-комментам в тексте программы. причём документация и в виде html тоже вроде - если меня склироз не подводит. токо сам я не очень с тэгами теми разобрался и забросил это дело. но планирую всёже к нему вернуться когда время будет. 
PM MAIL WWW ICQ   Вверх
Хоббит
Дата 22.5.2006, 20:39 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1263
Регистрация: 6.11.2005

Репутация: нет
Всего: 1



 smile  smile  smile  smile  smile  smile  smile ... smile ... точный адресс пожалуйста 
PM MAIL   Вверх
mr.DUDA
Дата 23.5.2006, 11:03 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


3D-маньяк
****


Профиль
Группа: Экс. модератор
Сообщений: 8244
Регистрация: 27.7.2003
Где: город-герой Минск

Репутация: 110
Всего: 232



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


--------------------
user posted image
PM MAIL WWW   Вверх
Pankon
Дата 23.5.2006, 14:26 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Опытный
**


Профиль
Группа: Участник
Сообщений: 739
Регистрация: 2.6.2005

Репутация: 3
Всего: 5



Цитата(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 
 
PM MAIL   Вверх
Хоббит
Дата 24.5.2006, 22:30 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1263
Регистрация: 6.11.2005

Репутация: нет
Всего: 1



та же шняга, даже когда dll скармливаю 
PM MAIL   Вверх
Ответ в темуСоздание новой темы Создание опроса
Прежде чем создать тему, посмотрите сюда:
mr.DUDA
THandle

Используйте теги [code=csharp][/code] для подсветки кода. Используйтe чекбокс "транслит" если у Вас нет русских шрифтов.
Что делать если Вам помогли, но отблагодарить помощника плюсом в репутацию Вы не можете(не хватает сообщений)? Пишите сюда, или отправляйте репорт. Поставим :)
Так же не забывайте отмечать свой вопрос решенным, если он таковым является :)


Если Вам понравилась атмосфера форума, заходите к нам чаще! С уважением, mr.DUDA, THandle.

 
1 Пользователей читают эту тему (1 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема | Общие вопросы по .NET и C# | Следующая тема »


 




[ Время генерации скрипта: 0.0953 ]   [ Использовано запросов: 21 ]   [ GZIP включён ]


Реклама на сайте     Информационное спонсорство

 
По вопросам размещения рекламы пишите на vladimir(sobaka)vingrad.ru
Отказ от ответственности     Powered by Invision Power Board(R) 1.3 © 2003  IPS, Inc.