Поиск:

Ответ в темуСоздание новой темы Создание опроса
> Авто документирование кода, Это нужно всем!!! 
:(
    Опции темы
Rapalex
Дата 21.3.2006, 15:14 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Опытный
**


Профиль
Группа: Участник
Сообщений: 732
Регистрация: 20.1.2006
Где: Украина -> Ник олаев

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



В VS 2002, VS 2003 есть кнопка в меню Tools. Точно не помню, как называ-ется, но что-то вроде “Create Html documentation”. Я лично сам потратил 2 дня чтоб понять как этим пользоваться. Что понял, сейчас в вкратце скажу.

Перед объявлением каждого класса и его метода или поля пишутся специ-альные комментарии с тегами <summary> и др. (посмотрите Help-е). После этого, когда нужно сгенерировать документацию к классам, нажимается кнопка в меню Tools, выбираются интересующие нас проекты, и просто ждём. После в выбранной директории находятся html файлы, открываем нужный и видим все классы, поля, методы и те комментарии, которые мы в файлах и писали. Всё очень красиво и похоже на MSDN.

Сейчас я в VS 2005 ели нашел способ сгенерировать XML файл который в себя и вбирает мои комментарии, это хорошо, НО одна незадача, чемпрос-матривать? Браузер отображает так, что читать невозможно.

Приведу пример, при переходе на VS 2005 создался log конверции старых sln и vsproj в новые. Этот log был файл xml, просматривая его Эксплорером я видел таблицы и др. и никакого xml.

Может кто знает как в VS 2005 пользоваться полученными xml файлами?



--------------------
In vitium ducit culpae fuga.
Желание избежать ошибки вовлекает в другую.
(Horatius)
PM ICQ   Вверх
srd
Дата 21.3.2006, 15:43 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Нереварин
**


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

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



Ищи программу NDoc - она берёт на входе полученные XML файлы и генерирует документацию в читабельном виде в нескольких форматах.



--------------------
Не смей читать мою подпись!!!
PM MAIL Jabber   Вверх
Rapalex
Дата 22.3.2006, 16:49 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Опытный
**


Профиль
Группа: Участник
Сообщений: 732
Регистрация: 20.1.2006
Где: Украина -> Ник олаев

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



Стянул, но она не хочет делать то что мне надо. Она может только с С# работать, чтоб добавить проект ей нужно указать сборку и xml файл. А exe от MFC ей не нравится, да и sln не катит.

srd, ето твоя догадка (ктото говорил) или ты этим сам пользовался, я может чегото не понимаю но что-то не так smile


--------------------
In vitium ducit culpae fuga.
Желание избежать ошибки вовлекает в другую.
(Horatius)
PM ICQ   Вверх
srd
Дата 22.3.2006, 18:42 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Нереварин
**


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

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



А, извиняюсь, я им пользовался в 2003 студии и только для C#. Кстати, обязательно ли нужен именно инструмент в самой студии? Есть же независимые средства для генерации документации, поддерживающие как Си, так и Си++, например doxygen.


--------------------
Не смей читать мою подпись!!!
PM MAIL Jabber   Вверх
Rapalex
Дата 22.3.2006, 20:17 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Опытный
**


Профиль
Группа: Участник
Сообщений: 732
Регистрация: 20.1.2006
Где: Украина -> Ник олаев

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



Я doxygen не пользовался но коментарии та уже написаны, что теперь их переписывать. smile

Кроме того мы же в студии работаем, в принцыпе её разработчики должны заботится о нас, давать нам всё необходимое и поддерживать старые версии.


--------------------
In vitium ducit culpae fuga.
Желание избежать ошибки вовлекает в другую.
(Horatius)
PM ICQ   Вверх
Rapalex
Дата 29.3.2006, 13:53 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Опытный
**


Профиль
Группа: Участник
Сообщений: 732
Регистрация: 20.1.2006
Где: Украина -> Ник олаев

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



Попробывал NDoc в C# в VS 2005 и ничего не вышло, я так понял версия .NET не подходит.

Так что нет такой проги чтоб мой xml файл с .NET тегами перегнать в html или chm, или во что нибудт подобное.


--------------------
In vitium ducit culpae fuga.
Желание избежать ошибки вовлекает в другую.
(Horatius)
PM ICQ   Вверх
sergejzr
Дата 29.3.2006, 14:05 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Un salsero
Group Icon


Профиль
Группа: Админ
Сообщений: 13285
Регистрация: 10.2.2004
Где: Германия г .Ганновер

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



Rapalex, дай как пример файла. Может самому можно XSL написать? Вообще, дока на XML это крутая идея!


--------------------
PM WWW IM ICQ Skype GTalk Jabber AOL YIM MSN   Вверх
Rapalex
Дата 29.3.2006, 19:57 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Опытный
**


Профиль
Группа: Участник
Сообщений: 732
Регистрация: 20.1.2006
Где: Украина -> Ник олаев

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



Идея ичень хороша, но Microsoft её не довёл, или не захотел довести до конца.
В MSDN есть подробная информация о том по каким правилам генерируется xml файл.

Студия на базе файла с кодом сама генерирует xml файл, мне не жалко я выложил и *.h *.xml файлы,
я думаю смысла в большие файлы нет необходимости.

Присоединённый файл ( Кол-во скачиваний: 1 )
Присоединённый файл  Intesdoc.zip 1,16 Kb


--------------------
In vitium ducit culpae fuga.
Желание избежать ошибки вовлекает в другую.
(Horatius)
PM ICQ   Вверх
  
Ответ в темуСоздание новой темы Создание опроса
0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема | Visual C++/MFC/WTL | Следующая тема »


 




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


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

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