14
ответов
Документация кода: Сколько слишком много?
Сколько документация кода в Вашем источнике.NET слишком много? Некоторый фон: Я наследовал большую кодовую базу, что я говорил о в некоторых из других вопросов, на которых я отправил здесь ТАК. Один из "...
вопрос задан: 13 November 2008 21:36
6
ответов
.Net XML comment в документацию API
Существует ли простой способ произвести документацию стиля MSDN из Visual Studio вывод XML? Я не достаточно терпелив для установки хорошего xslt для него, потому что я знаю, что я не первый человек, который пересечет это...
вопрос задан: 25 June 2014 19:54
6
ответов
Замок из песка - все еще правильная вещь использовать? Или есть ли альтернативы? [закрытый]
Я просто задаюсь вопросом - последний выпуск Замка из песка с мая 2008, и он все еще перечислен как предварительный выпуск Software/CTP, и он больше даже не лицензируется, как specifially говорит EULA: 2. ТЕРМИН...
вопрос задан: 12 June 2009 13:50
6
ответов
Инструмент поколения справки с MS Word и [закрытой] поддержкой C# xmldoc
Я ищу инструмент поколения справки/документации, который удовлетворил бы такие требования: это должно поддерживать комментарий xmldoc, произведенный c# компилятором, или (еще лучше) непосредственно поддерживать замок из песка это...
вопрос задан: 20 April 2009 14:24
6
ответов
XML Комментарий подсказок для [закрытого] программирования C#
Доброе утро, день, вечер или ночь (в зависимости от Вашего часового пояса). Это - просто общий вопрос о XML, комментирующем в C#. Я никогда не был очень крупным в комментарий моих программ, я имею...
вопрос задан: 10 December 2008 12:58
6
ответов
Документация кода для Дельфи, подобного javadoc или c# xml документ
Мне нужен инструмент документации кода, подобный javadoc или c# xml документ для кода Дельфи. Каков лучший инструмент? Я предпочитаю технологию, которая находится в будущем, совместимом с проектом замка из песка Microsoft.
вопрос задан: 25 October 2008 07:24
4
ответа
Действительно ли SandCastle является мертвым проектом? [закрытый]
Microsoft уничтожила NDoc, когда они выпустили версию CTP/Beta Замка из песка, и я редко вижу информацию о новой версии применимой версии замка из песка (с интегрированным UI, например)...
вопрос задан: 27 December 2012 22:59
4
ответа
Автоматически пример кода модульного теста
Моя команда ответственна за разработку API для большой системы, которую мы также пишем. Мы должны обеспечить пример кода так, чтобы другие разработчики, использующие наш API, могли изучить, как использовать его. Мы были...
вопрос задан: 19 November 2008 09:21
3
ответа
Как я должен зарегистрировать свой код C#? [закрытый]
Я создаю документацию для нашего API C#, содержащего: общий обзор и описание текущего состояния как файл документа/PDF. Библиотека классов API в .chm файле с помощью Замка из песка. Questions:...
вопрос задан: 2 April 2009 21:51
3
ответа
DocProject по сравнению с разработчиком справочного файла замка из песка GUI
У меня есть несколько проектов C# наряду с некоторыми внутренними компонентами библиотеки, которые я пытаюсь зарегистрировать вместе. Замок из песка, кажется, место для движения для генерации документации от C#. Я хотел бы...
вопрос задан: 26 November 2008 03:00
3
ответа
Генерируйте документацию HTML автоматически во время сборки с Замком из песка
Какие шаги я должен сделать для получения документации HTML, автоматически создающей через шаг сборки в Visual Studio? Я имею в распоряжении все комментарии и файл comments.xml, сгенерированный, и...
вопрос задан: 2 November 2008 00:41
2
ответа
Мы можем ускорить замок из песка?
Мы используем замок из песка (и SHFB) для генерации документации библиотеки классов из встроенных XML-комментариев. Это - большой инструмент для поддержания полной и профессионально выглядящей ссылки + обзор...
вопрос задан: 23 May 2017 12:31
2
ответа
Преобразуйте Разработчика Справочного файла Замка из песка Вывод (веб-сайт) к формату MediaWiki
Я должен преобразовать свой вывод Разработчика справочного файла замка из песка (SHFB), который является веб-сайтом (HTML) к Медиа, формат Wiki Находит способ передавать/включать преобразованные страницы непосредственно в MediaWiki мы...
вопрос задан: 26 September 2013 10:20
2
ответа
существует ли плагин замка из песка для Visual Studio 2010?
Мне действительно нравятся справочные файлы, сгенерированные с помощью SandCastle на моих проектах... там плагин для Visual Studio 2010 для SandCastle или другая хорошая альтернативная программа, которая интегрируется непосредственно с...
вопрос задан: 29 July 2010 07:04
2
ответа
Документирование Интерфейсов и их [закрытой] реализации
Я украшаю свой код C# комментариями, таким образом, я могу произвести справочные файлы HTML. Я часто объявляю и интерфейсы документа. Но классы реализовывая те интерфейсы могут выдать определенные исключения в зависимости от...
вопрос задан: 4 January 2010 05:48
2
ответа
Как связаться / перегрузки группы в XML-комментариях C#?
В XML documentaiton комментарии для C#, там способ отметить две или больше функции, чтобы быть перегрузками друг друга, так, чтобы они сослались друг на друга автоматически? Идеально, они были бы также сгруппированы в...
вопрос задан: 26 December 2008 12:09
1
ответ
Несколько примеров языка в Документации XML
Существует ли способ включать примеры для нескольких языков (C# и Visual Basic, например) в документации XML? Я использую SandCastle для создания документации стиля MSDN и хотел бы включать...
вопрос задан: 24 May 2010 22:17
1
ответ
Документирование Замка из песка использования: Обращение к использованию перечисления значений <видит>
Я использую Замок из песка 2.4.10520 и Разработчика Справочного файла Замка из песка 1.8.0 для генерации .chm справочного файла. В моей документации я использую, <посмотрите> теги. Если я пытаюсь относиться, перечисление как <см. cref = "...
вопрос задан: 1 May 2010 14:38
1
ответ
поместите пример кода в документацию при помощи замка из песка
я генерирую файлы документации из xml комментариев моего кода c#, при помощи разработчика справочного файла замка из песка. Вы знаете, как включать примеры кода в справочный файл, как стиль MSDN?
вопрос задан: 9 June 2009 07:25
1
ответ
Классы реализации могут “наследовать” XML-комментарии от своих реализованных интерфейсов?
Любопытный вопрос. Я использую Замок из песка Microsoft для генерации документации из XML-комментариев в моем коде C#. Несколько из моих классов реализуют интерфейсы, которые уже прокомментировали...
вопрос задан: 6 April 2009 16:29
1
ответ
Делает любой знает о хорошем [закрытом] редакторе MAML
На работе мы используем Замок из песка для создания справочных файлов. Я использовал SandCastleGUI в течение некоторого времени, и я ищу способ создать дополнительные страницы в справочном файле. Эти страницы записаны в...
вопрос задан: 9 March 2009 21:06
1
ответ
Документация пространства имен относительно проекта .NET (Замок из песка)?
Я начал использовать Замок из песка некоторое время назад для генерации Веб-сайта Документации для одного из наших проектов. Это работает вполне хорошо, но мы всегда только писали документацию для классов, методы...
вопрос задан: 1 October 2008 09:27
0
ответов
Sandcastle Help File Builder не может найти источник документации
Я создаю документ проекта VS 2010 C #с помощью построителя файлов справки Sandcastle. Я добавил документацию.xml, сгенерированную компилятором, и файл.sln решения Visual Studio проекта...
вопрос задан: 24 March 2019 21:35
0
ответов
Создание файлов HTML / справки из документации VS 2010 C # XML
Я ищу хороший инструмент для создания файлов HTML / справки из моей документации VS2010 XML. Я нашел некоторые коммерческие инструменты, такие как инструмент документации .Net
VSDocman Я уверен, что их гораздо больше, я ...
вопрос задан: 24 March 2019 16:51
0
ответов
Как лучше всего документировать код f #?
Я пробовал Sandcastle с исправлениями, включенными в управляемую установку с графическим интерфейсом пользователя, но если я не делаю что-то очень неправильное, он в основном не подходит для документирования кода F # (даже если он будет работать ...
вопрос задан: 23 May 2017 12:02
0
ответов
Как отключить определенное предупреждение компилятора для определенного файла
Предыстория Я работаю над небольшим проектом по кодированию, который будет продан другим компаниям. Мне нужно было создать для него некоторую документацию,поэтому я решил использовать Sandcastle. После слишком долгого...
вопрос задан: 23 May 2017 11:59
0
ответов
XML-комментарии к частичным классам / методам
Существует ли стандартный способ, которым инструменты, используемые для создания документов API, обрабатывают комментарии стиля XML к частичным классам? В принципе, как следует прокомментировать частичный класс / метод, чтобы ...
вопрос задан: 16 December 2015 15:28
0
ответов
XML Комментарии - Документация MSDN "Примечание" Раздел - Как вы дублируете это?
в основном, в онлайн-справке MSDN, я часто запускаю в раздел «Примечание», но Не может за жизнь меня выяснить, как получить этот же выход. По-видимому, нет тегов . Кто-нибудь знает ...
вопрос задан: 26 March 2015 19:57
0
ответов
Как игнорировать документацию, созданную конструктором файлов справки для общедоступных классов или методов?
Как я могу не включать определенные общедоступные классы или методы в документацию, созданную с помощью The SandCastle Help File Builder? Пример: у меня есть следующий общедоступный класс с двумя общедоступными...
вопрос задан: 10 April 2013 20:00
0
ответов
Действительно ли возможно объединить две страницы, созданные SandCastle в единственную основную страницу?
Для каждого класса в проекте SandCastle создает (среди других) две страницы: основная страница, названная как T_class_full_name, с описанием, Синтаксисом, Иерархией наследования и, Видит Также участников...
вопрос задан: 28 January 2013 09:53