6
ответов

Инструмент поколения справки с MS Word и [закрытой] поддержкой C# xmldoc

Я ищу инструмент поколения справки/документации, который удовлетворил бы такие требования: это должно поддерживать комментарий xmldoc, произведенный c# компилятором, или (еще лучше) непосредственно поддерживать замок из песка это...
вопрос задан: 20 April 2009 14:24
6
ответов

Eclipse: методы списка и переменные всех [закрытых] классов

Я начинаю использовать некоторый код Java, который был написан кем-то еще. Я должен понять, изменить и протестировать его. Автор не доступен теперь. Пакет имеет приблизительно 50 файлов (и так классы)...
вопрос задан: 14 April 2009 23:39
6
ответов

XML Комментарий подсказок для [закрытого] программирования C#

Доброе утро, день, вечер или ночь (в зависимости от Вашего часового пояса). Это - просто общий вопрос о XML, комментирующем в C#. Я никогда не был очень крупным в комментарий моих программ, я имею...
вопрос задан: 10 December 2008 12:58
5
ответов

Почему методы в документации Ruby предшествовавшие знаком хеша?

Когда я вижу любой метод Ruby, распечатанный в тексте, это обычно появляется как: Class#method или #method Теперь, я использовал бы: Class.method, Почему всем методам Ruby предшествует знак фунта? Есть ли любая причина...
вопрос задан: 26 October 2019 11:30
5
ответов

Где документация Python для специальных методов? (__ init __, __ новый __, __ len __, …)

Где полный список специальных double-underscore/dunder методов, которые могут использоваться в классах? (например, __ init __, __ новый __, __ len __, __ добавляют __),
вопрос задан: 6 May 2019 08:17
5
ответов

Как я могу создать .chm файлы из кода C#?

Я использовал doxygen для создания файлов HTML, теперь я хочу преобразовать ту документацию в .chm формат. Как я могу сделать это?
вопрос задан: 12 December 2018 13:03
5
ответов

Как модульные тесты должны быть зарегистрированы? [закрытый]

Я пытаюсь улучшить число и качество тестов в моих проектах Python. Один из трудности, с которыми я встретился как количество тестового увеличения, знают то, что делает каждый тест и как это...
вопрос задан: 23 May 2017 12:34
5
ответов

Определенные примеры Гибкой документации? [закрытый]

В ответе на Документы вопроса для проекта?, Chris Ballance ответил, что "Пользовательские Истории" и "burndown диаграмма" являются двумя самыми полезными типами проектной документации для разработчика. Мой...
вопрос задан: 23 May 2017 12:16
5
ответов

Сравните и контрастируйте легкие [закрытые] языки разметки

Определите самые популярные легкие языки разметки и сравните их достоинства и недостатки. Эти языки должны быть разметкой общего назначения для технической прозы, такой что касается...
вопрос задан: 23 May 2017 12:10
5
ответов

Лучший способ зарегистрировать интерфейс WCF? [закрытый]

Таким образом, я использую WCF и хочу зарегистрировать свой интерфейс (интерфейсы) и сервисы, чтобы дать другой компании для внутреннего приложения. Что лучший способ состоит в том, чтобы зарегистрировать те интерфейсы? Я предпочел бы иметь...
вопрос задан: 5 August 2016 06:34
5
ответов

Почему Python функционирует, документы включают запятую после скобки для дополнительного args?

Формат функциональных подписей в документах Python немного сбивает с толку. Каково значение в помещении запятой после открытой скобки, а не прежде? Из чего значение...
вопрос задан: 5 March 2016 22:02
5
ответов

Что-нибудь лучше, чем PHPDoc там? [закрытый]

Кто-либо использует что-либо еще для документирования их кода PHP, чем PHPDoc? Есть ли какие-либо инструменты, которые читают тот же синтаксис документации, но дают более богатый вывод?
вопрос задан: 5 June 2015 18:51
5
ответов

Процесс записи [закрытой] технической спецификации

Я немного волнуюсь, что это может быть дубликатом, но я искал сайт и каждый вопрос, который я могу найти, кажется, более фокусируется на функциональных спецификациях, а не технических. Я'...
вопрос задан: 3 April 2014 06:11
5
ответов

Офлайновая документация Java [закрывается]

Я наконец нашел время для изучения Java, и ищу некоторую документацию для Java, который я могу загрузить и считать офлайн. Что-то как материал Sun, но заархивированный или как PDF или CHM. Я использую...
вопрос задан: 5 August 2013 21:26
5
ответов

Документирование C++ / код библиотеки CLI для использования от c# - лучшие инструменты и методы? [закрытый]

Я работаю над проектом, где c ++/cli библиотека используется, прежде всего, из c# приложения. Там какой-либо путь состоит в том, чтобы сделать комментарии к коду в c ++/cli видимыми к c# intellisence в рамках Visual Studio?...
вопрос задан: 16 April 2010 20:33
5
ответов

Как я мог представить прерывание (для микроконтроллеров) в блок-схеме? [закрытый]

У кого-либо есть какие-либо визуальные примеры?
вопрос задан: 31 March 2010 16:44
5
ответов

Как добавить объекты, включенные <> к комментариям для документации

Я пытаюсь записать комментарии для документации однако, у меня есть проблема.///<сводка>///Вставляет элемент в Систему. Наборы. Универсальный. Список <T> в указанном индексе///.///</...
вопрос задан: 2 March 2010 22:31
5
ответов

Документация модульного теста [закрывается]

Я хотел бы знать от тех, кто документирует модульные тесты, как они документируют его. Я понимаю, что большинство подписчиков TDD утверждает, что "код говорит", и таким образом документация по тестированию не очень важна...
вопрос задан: 4 February 2010 09:16
5
ответов

Visual Studio с DoxyGen для документации, или мы должны использовать что-то еще? [закрытый]

Мы в настоящее время используем DoxyGen для документирования кода, написанного в C/C++, PHP и Java. Чтобы иметь последовательную среду, было бы хорошо использовать его для документации C# также. Однако мы задаемся вопросом: Сделать...
вопрос задан: 8 January 2010 04:43
5
ответов

Создание документации для [закрытых] классов Python

Я собираюсь запустить проект, где я буду единственным, делающим фактический код и двух менее опытных программистов (страшный для размышления обо мне, как испытано!) будет наблюдать и делать предложения на...
вопрос задан: 15 June 2009 20:00
5
ответов

Как сохранить код и спецификации в синхронизации? - там хорошие [закрытые] инструменты

В моей команде у нас есть большая система управления исходным кодом, и у нас есть большие спецификации. Проблема, которую я хотел бы решить, состоит в том, как усовершенствовать спецификации кода. Со временем спецификации имеют тенденцию стареть и...
вопрос задан: 26 May 2009 23:37
5
ответов

документация по коду для python [закрыто]

Что там в соглашениях и инструментах для документирования исходного кода Python?
вопрос задан: 11 March 2009 16:54
5
ответов

Альтернатива Example.com [закрывается]

Скажем, Вы хотите обеспечить URL в качестве примера в документации где-нибудь. Корректная вещь сделать использовать example.com, так как это - определенное местоположение для таких вещей и чего-либо еще, что Вы подходите...
вопрос задан: 5 March 2009 11:47
5
ответов

Документация Заголовочного файла C/C++ [закрывается]

То, что Вы думаете, является лучшей практикой при создании общедоступных заголовочных файлов в C++? Заголовочные файлы должны содержать не, краткая или крупная документация? Я видел все почти ни из какой документации (надежда...
вопрос задан: 28 January 2009 10:15
5
ответов

Куда поместить doxygen блоки комментария для внутренней библиотеки - в H или в файлах CPP? [закрытый]

Здравый смысл говорит, что блоки комментария Doxygen должны быть помещены в заголовочные файлы, где классы, структуры, перечисления, функции, объявления. Я соглашаюсь, что это - звуковой аргумент в пользу...
вопрос задан: 10 December 2008 10:23
5
ответов

Какие члены отображаются в документах модуля python? [Дубликат]

Если я создаю модуль python и I wand, чтобы просмотреть его документы либо с помощью справки (mymodule), либо pydoc mymodule, как определяется, какие члены моего модуля отображаются в документе? Например, скажем, мой ...
вопрос задан: 16 September 2008 18:06
5
ответов

Справочный файл (или руководство пользователя) мертв? [закрытый]

Назад в эпоху Unix, Вы не могли даже закрыть программное обеспечение, не читая страницу справочника сначала. Тогда прибыл Mac и Windows с последовательным расположением меню и сочетаниями клавиш, но Вы все еще видели бумагу...
вопрос задан: 13 September 2008 21:14
4
ответа

Генерация документации HTML от [закрытого] WSDL

Что Ваши подходы к генерации своего рода человекочитаемой документации от WSDLs? В прошлом я использовал средство просмотра WSDL (Tomi Vanek), и я доволен результатами, но я интересуюсь любым...
вопрос задан: 2 July 2019 00:14
4
ответа

Что % делает к строкам в Python? [закрытый]

Мне не удалось найти документацию для % оператора, поскольку она используется на строках в Python. Что делает этот оператор, когда он используется со строкой на левой стороне?
вопрос задан: 2 May 2019 17:55
4
ответа

Как Вы документируете свои функции PHP и встроенные классы? [закрытый]

Я знаю, что существует много различных стандартов для кода PHP встроенная документация. Вот то, что я подразумеваю под встроенной документацией, и исправьте меня, если существует лучший термин: / ** * Это - описание...
вопрос задан: 12 March 2019 04:47