1
ответ
В xml документе я могу вставить ссылку на группу метода? Как?
В C# я могу присоединить документацию для свойств, методы, события, и так далее, непосредственно в коде с помощью Комментариев Документации XML. Я знаю, как вставить ссылку на конкретный метод: <...
вопрос задан: 15 September 2009 23:55
1
ответ
XML-комментарии, не показывающие на Vb. Сеть
Я использую что-то подобное этому, и оно не отобразит Сводку или Комментарии, когда я попытаюсь использовать Intellisense для этой функции? ''' <сводка>' '' Сводка ''' </summary&...
вопрос задан: 25 August 2009 16:19
1
ответ
GNU [закрытые] сообщения об ошибках C++
Существует ли всесторонний список ошибки/предупреждающих сообщений для g ++ компилятор, доступный онлайн? Я ищу что-то подобное документации MSDN, которая описывает то, что каждое сообщение означает и...
вопрос задан: 25 June 2009 12:33
1
ответ
поместите пример кода в документацию при помощи замка из песка
я генерирую файлы документации из xml комментариев моего кода c#, при помощи разработчика справочного файла замка из песка. Вы знаете, как включать примеры кода в справочный файл, как стиль MSDN?
вопрос задан: 9 June 2009 07:25
1
ответ
Там существует “Wiki” для редактирования doxygen комментарии? [закрытый]
Я работаю над довольно большим механизмом стратегии в реальном времени с открытым исходным кодом (Spring). Я недавно добавил набор новых функций C++, вызываемых Lua, и задаюсь вопросом как к лучшему документу их, и в то же время также...
вопрос задан: 30 May 2009 21:06
1
ответ
Делает любой знает о хорошем [закрытом] редакторе MAML
На работе мы используем Замок из песка для создания справочных файлов. Я использовал SandCastleGUI в течение некоторого времени, и я ищу способ создать дополнительные страницы в справочном файле. Эти страницы записаны в...
вопрос задан: 9 March 2009 21:06
1
ответ
Документация пространства имен относительно проекта .NET (Замок из песка)?
Я начал использовать Замок из песка некоторое время назад для генерации Веб-сайта Документации для одного из наших проектов. Это работает вполне хорошо, но мы всегда только писали документацию для классов, методы...
вопрос задан: 1 October 2008 09:27
1
ответ
Документация HelpInsight в Delphi 2007
Я использую D2007 и пытаюсь зарегистрировать свой исходный код, используя функцию HelpInsight (обеспеченный начиная с D2005). Я главным образом интересуюсь получением работы подсказок HelpInsight. С различной сети-...
вопрос задан: 10 September 2008 23:21
0
ответов
Следует ли писать XML-комментарии для интерфейсов, конкретных реализаций или того и другого? [закрыто]
Меня интересует, где я могу применить свои XML-комментарии. Должен ли я добавить более общий XML-комментарий в интерфейс и более описательный в реализующий класс? Как это: открытый интерфейс ...
вопрос задан: 24 November 2019 17:23
0
ответов
Какой класс использовать: @return self, этот или текущий? [closed]
У меня есть метод, возвращающий текущий объект, как мне это задокументировать? / ** * что-то установить * * @ вернуть * /
публичная функция setSomething () {// ... return $ this;
} Или я должен ...
вопрос задан: 8 August 2019 15:17
0
ответов
Строка документации Clojure для библиотек/пространств имен
Как добавить строки документации и/или комментарии к библиотекам/пространствам имен Clojure в целом, то есть не только к конкретным функциям в пространстве имен? Я заметил, что исходный код clojure использует комментарий (... )в...
вопрос задан: 24 July 2019 11:21
0
ответов
Как задокументировать метод с параметром (ами)?
Как задокументировать методы с параметрами, используя строки документации Python? РЕДАКТИРОВАТЬ: PEP 257 дает следующий пример: def complex (real = 0.0, imag = 0.0): "" "Сформируйте комплексное число. Аргументы ключевого слова: ...
вопрос задан: 2 July 2019 23:28
0
ответов
Как интерпретировать параметры функции API документации? [Закрыто]
Есть ли стандарт интерпретировать синтаксис функциональных интерфейсов API документаций и если да, то как это определено? Вот пример того, как изменить цвет элемента JavaScript ...
вопрос задан: 19 June 2019 10:03
0
ответов
Как можно увидеть комментарии к полям из клиента mysql?
Я хотел бы видеть комментарии к отдельным полям. Обычно я чего-то ожидаю от «описывающих» параметров. mysql> описать метрики;
+ ------- + --------------------- + ------ + - --- + --------- + -------...
вопрос задан: 9 April 2019 14:46
0
ответов
Что эквивалентно строке документации Python в Ruby?
В Python вы можете получить доступ к строке документации объекта с помощью obj .__ doc__. Какое действие эквивалентно в Ruby?
вопрос задан: 2 April 2019 20:28
0
ответов
gem: --no-rdoc --no-ri не работает в macOS
Я добавил эту строку в мой файл .gemrc: gem: --no-rdoc --no-ri Я использую rvm, однако при установке gem я получаю следующий вывод: Mac-mini: ~ user $ gem install Fastlane успешно ...
вопрос задан: 29 March 2019 12:06
0
ответов
Централизация документации для программного обеспечения
В нашей организации у нас есть около 100 программных документов (API, SOAP, технические и т. Д.), Сохраненных в репозитории SVN. Сохранение документов в SVN имеет некоторые преимущества, например, управление версиями. Но доступ ...
вопрос задан: 29 March 2019 11:45
0
ответов
Как документировать переопределенные / реализованные функции без Doxygens @copydoc?
Как Могу ли я задокументировать переопределенный метод или реализованный виртуальный метод подкласса? Стоит ли использовать @copydoc? class A {/ ** * Подробное описание ........ * / virtual int foo (int i);
...
вопрос задан: 26 March 2019 11:32
0
ответов
What Doxygen alternative would Dave DeLong use?
Yesterday, Dave DeLong answered a question of mine. It wasn't the answer I was looking for, but in the question he mentioned an alternative way of generating doxygen-style documentation for Objective-...
вопрос задан: 25 March 2019 21:42
0
ответов
Sandcastle Help File Builder не может найти источник документации
Я создаю документ проекта VS 2010 C #с помощью построителя файлов справки Sandcastle. Я добавил документацию.xml, сгенерированную компилятором, и файл.sln решения Visual Studio проекта...
вопрос задан: 24 March 2019 21:35
0
ответов
Преобразование phpdoc в набор документов для использования Dash
Я пытаюсь получить документацию Magento в формате, который я могу использовать в Dash. В статье на сайте Dash описано, как импортировать ряд видов документации в нужный формат,...
вопрос задан: 18 March 2019 14:22
0
ответов
Инструменты для документации Socket.io
Есть ли инструменты для документирования сервера socket.io? Я ищу инструмент, который позволяет документировать пространства имен / событий / конечных точек socket.io так, как это делает почтальон / сваггер (...
вопрос задан: 17 March 2019 20:26
0
ответов
Как документировать конфигурационные файлы?
Есть ли лучшие практики для документации по файлам конфигурации, особенно для python? В частности, в научных вычислениях обычно используется файл конфигурации в качестве входных данных для управления пакетной обработкой ...
вопрос задан: 5 March 2019 23:10
0
ответов
Почтальон: добавить заметки в опубликованную документацию
Я создал общедоступную ссылку на публикацию коллекции. Мне интересно, как я могу добавить заметки в этот публичный документ, например, у моего API есть некоторые параметры, и я хочу указать, какие из них ...
вопрос задан: 28 February 2019 23:20
0
ответов
Как добавить комментарии уровня пакета в Javadoc? [duplicate]
Я использую CheckStyle, FindBugs и PMD для проверки моего кода Java. Я исправил почти все ошибки, обнаруженные этими инструментами. Я не могу понять, как написать «комментарий к пакету», который является ошибкой ...
вопрос задан: 24 February 2019 02:56
0
ответов
Показать < возвращает > тег XML в визуальную студию intellisense
Я добавил < Returns > XML-тег для некоторых из моих методов, но я не вижу его содержимое в IntelliSense. Вот мой код: /// < summary > /// мы все живем в желтой сводке /// < / summary > // ...
вопрос задан: 5 February 2019 17:00
0
ответов
Пример кода .NET для провайдера идентификации SAML [закрыто]
Я бы хотел использовать SAML, чтобы разрешить аутентифицированные пользователи веб-сайта для входа на другие федеративные сайты. Говоря языком единого входа, это означает, что мой сайт должен стать поставщиком удостоверений. Кто-нибудь может указать ...
вопрос задан: 29 January 2019 16:12
0
ответов
Есть ли какая-либо причина, связанная с производительностью, почему во многих кодовых базах отсутствует встроенная документация?
Я заметил, что многие известные проекты с открытым исходным кодом редко содержат значительное количество комментариев и встроенной документации. Учитывая, что основной целью комментирования является прояснение того, что ...
вопрос задан: 20 January 2019 04:57
0
ответов
как показать атрибуты экземпляра в sphinx doc?
Есть ли способ, как автоматически показывать переменные var1 и var2 и их значения инициализации в документации sphinx? class MyClass: "" "Описание класса" "" def __init __ (self, ...
вопрос задан: 18 January 2019 01:11
0
ответов
java-документация [закрыто]
я не могу создать документацию для этого кода, я думаю, что мой coomad javadoc неправильный, я читал об этом, но не понимаю, может ли кто-нибудь исправить по javadoc cammand class abc
{/ ** documentaion ...
вопрос задан: 23 December 2018 05:37