Я ищу инструмент поколения справки/документации, который удовлетворил бы такие требования: это должно поддерживать комментарий xmldoc, произведенный c# компилятором, или (еще лучше) непосредственно поддерживать замок из песка это...
Я начинаю использовать некоторый код Java, который был написан кем-то еще. Я должен понять, изменить и протестировать его. Автор не доступен теперь. Пакет имеет приблизительно 50 файлов (и так классы)...
Доброе утро, день, вечер или ночь (в зависимости от Вашего часового пояса). Это - просто общий вопрос о XML, комментирующем в C#. Я никогда не был очень крупным в комментарий моих программ, я имею...
Когда я вижу любой метод Ruby, распечатанный в тексте, это обычно появляется как: Class#method или #method Теперь, я использовал бы: Class.method, Почему всем методам Ruby предшествует знак фунта? Есть ли любая причина...
Где полный список специальных double-underscore/dunder методов, которые могут использоваться в классах? (например, __ init __, __ новый __, __ len __, __ добавляют __),
Я пытаюсь улучшить число и качество тестов в моих проектах Python. Один из трудности, с которыми я встретился как количество тестового увеличения, знают то, что делает каждый тест и как это...
В ответе на Документы вопроса для проекта?, Chris Ballance ответил, что "Пользовательские Истории" и "burndown диаграмма" являются двумя самыми полезными типами проектной документации для разработчика. Мой...
Определите самые популярные легкие языки разметки и сравните их достоинства и недостатки. Эти языки должны быть разметкой общего назначения для технической прозы, такой что касается...
Таким образом, я использую WCF и хочу зарегистрировать свой интерфейс (интерфейсы) и сервисы, чтобы дать другой компании для внутреннего приложения. Что лучший способ состоит в том, чтобы зарегистрировать те интерфейсы? Я предпочел бы иметь...
Формат функциональных подписей в документах Python немного сбивает с толку. Каково значение в помещении запятой после открытой скобки, а не прежде? Из чего значение...
Кто-либо использует что-либо еще для документирования их кода PHP, чем PHPDoc? Есть ли какие-либо инструменты, которые читают тот же синтаксис документации, но дают более богатый вывод?
Я немного волнуюсь, что это может быть дубликатом, но я искал сайт и каждый вопрос, который я могу найти, кажется, более фокусируется на функциональных спецификациях, а не технических. Я'...
Я наконец нашел время для изучения Java, и ищу некоторую документацию для Java, который я могу загрузить и считать офлайн. Что-то как материал Sun, но заархивированный или как PDF или CHM. Я использую...
Я работаю над проектом, где c ++/cli библиотека используется, прежде всего, из c# приложения. Там какой-либо путь состоит в том, чтобы сделать комментарии к коду в c ++/cli видимыми к c# intellisence в рамках Visual Studio?...
Я пытаюсь записать комментарии для документации однако, у меня есть проблема.///<сводка>///Вставляет элемент в Систему. Наборы. Универсальный. Список <T> в указанном индексе///.///</...
Я хотел бы знать от тех, кто документирует модульные тесты, как они документируют его. Я понимаю, что большинство подписчиков TDD утверждает, что "код говорит", и таким образом документация по тестированию не очень важна...
Мы в настоящее время используем DoxyGen для документирования кода, написанного в C/C++, PHP и Java. Чтобы иметь последовательную среду, было бы хорошо использовать его для документации C# также. Однако мы задаемся вопросом: Сделать...
Я собираюсь запустить проект, где я буду единственным, делающим фактический код и двух менее опытных программистов (страшный для размышления обо мне, как испытано!) будет наблюдать и делать предложения на...
В моей команде у нас есть большая система управления исходным кодом, и у нас есть большие спецификации. Проблема, которую я хотел бы решить, состоит в том, как усовершенствовать спецификации кода. Со временем спецификации имеют тенденцию стареть и...
Скажем, Вы хотите обеспечить URL в качестве примера в документации где-нибудь. Корректная вещь сделать использовать example.com, так как это - определенное местоположение для таких вещей и чего-либо еще, что Вы подходите...
То, что Вы думаете, является лучшей практикой при создании общедоступных заголовочных файлов в C++? Заголовочные файлы должны содержать не, краткая или крупная документация? Я видел все почти ни из какой документации (надежда...
Здравый смысл говорит, что блоки комментария Doxygen должны быть помещены в заголовочные файлы, где классы, структуры, перечисления, функции, объявления. Я соглашаюсь, что это - звуковой аргумент в пользу...
Если я создаю модуль python и I wand, чтобы просмотреть его документы либо с помощью справки (mymodule), либо pydoc mymodule, как определяется, какие члены моего модуля отображаются в документе? Например, скажем, мой ...
Назад в эпоху Unix, Вы не могли даже закрыть программное обеспечение, не читая страницу справочника сначала. Тогда прибыл Mac и Windows с последовательным расположением меню и сочетаниями клавиш, но Вы все еще видели бумагу...
Что Ваши подходы к генерации своего рода человекочитаемой документации от WSDLs? В прошлом я использовал средство просмотра WSDL (Tomi Vanek), и я доволен результатами, но я интересуюсь любым...
Мне не удалось найти документацию для % оператора, поскольку она используется на строках в Python. Что делает этот оператор, когда он используется со строкой на левой стороне?
Я знаю, что существует много различных стандартов для кода PHP встроенная документация. Вот то, что я подразумеваю под встроенной документацией, и исправьте меня, если существует лучший термин: / ** * Это - описание...