Описание тега ndoc
3
ответа
Ндок по свойствам лучшей практики?
Мой менеджер проекта на прошлой неделе намекнул на использование ndoc для свойств в классе. Это то, что должно быть сделано? Это считается лучшей практикой, чтобы сделать это или нет? В настоящее время я расширяю весь свой ndoc для раздела проекта, …
11 июн '12 в 14:03
2
ответа
Самый простой способ добавить XML документ в проект WinRT
У нас есть группа разработчиков, которая переходит с C++ на C# и WinRT. Мы использовали D'Oxygen в качестве части наших сборок для разработчиков на C++, и я хотел бы продолжить создание документов в рамках сборки для разработчиков на C#/WinRT. Включ…
06 фев '13 в 21:29
2
ответа
Как я могу ссылаться на MSDN/ официальную документацию из моих комментариев к документации C# XML?
Учитывая XML-комментарий к классу что-то вроде этого: ///<summary>Handles the AuthenticateRequest event in the ASP.NET page request lifecycle to authenticate users.</summary> ///<remarks> ///<para>This module will authenticat…
07 июл '11 в 10:58
4
ответа
SandCastle - это мертвый проект?
Microsoft убила NDoc, когда выпустила CTP/ бета-версию Sandcastle, и я редко вижу информацию о новой версии пригодной для использования версии sandcastle (например, с интегрированным пользовательским интерфейсом). Последний релиз выпущен в мае 2008 …
24 мар '10 в 13:35
1
ответ
Документация с NDOC3
Я работаю над проектной документацией с использованием NDOC3. Сбой сборки при попытке документировать сторонние библиотеки DLL (потому что у меня нет документации по xml для них). Как я могу решить эту проблему?
08 июн '10 в 08:16
1
ответ
NDOC Ошибка построения документации.
Используя.NET Framework 3.5, у меня есть nant -0.91-alpha2, в котором есть поддержка framework 3.5, но я получаю следующую ошибку при попытке собрать документацию. Error building Documentation. Object reference not set to an instance of object. Obje…
22 авг '11 в 10:22
3
ответа
.NET XML документы - наследование документации
В NDoc есть XML-элемент наследовать, который позволяет вам наследовать документацию члена от родительского класса (или реализованного интерфейса). Однако Visual Studio (то есть компилятор C#) не понимает этот тег и жалуется на то, что документация о…
22 ноя '08 в 13:53
1
ответ
Документация HelpInsight в Delphi 2007
Я использую D2007 и пытаюсь документировать свой исходный код, используя функцию HelpInsight (предоставляется с D2005). В основном меня интересует работа подсказок HelpInsight. Из различных веб-серфинга и экспериментов я обнаружил следующее: Использ…
10 сен '08 в 00:04
0
ответов
Проблема отражения.Net с помощью методов в NDoc
Я уже довольно давно использую NDoc, используя специализированную сборку (т.е. слегка исправленную ошибку) NDoc Enhanced ( http://sourceforge.net/projects/ndoc-e/), но столкнулся со странной проблемой с методами, которые имеют параметры, которые сам…
05 янв '10 в 16:50
8
ответов
Каковы лучшие практики для документирования кода C# с комментариями XML?
Я просматриваю новый код, который только что написал, и добавляю комментарии NDoc sytle к своим классам и методам. Я надеюсь создать довольно хороший документ в стиле MSDN для справки. В целом, каковы хорошие рекомендации при написании комментариев …
29 июн '10 в 17:46
14
ответов
Документация по коду: сколько стоит слишком много?
Сколько документации в вашем исходном коде.NET слишком много? Немного предыстории: я унаследовал большую кодовую базу, о которой я говорил в некоторых других вопросах, которые я разместил здесь на SO. Одной из "особенностей" этой кодовой базы являет…
13 ноя '08 в 21:04