4
ответа

Документирование веб-приложения Поток / [закрытый] Iteraction

Какие артефакты / схемы действительно используют для документирования потока веб-приложения, принимающего во внимание ссылки между статическими страницами и как компоненты динамического представления (формы HTML, JSP, Ajax, и т.д.) взаимодействуют с...
вопрос задан: 5 May 2009 14:55
4
ответа

Как смочь извлечь комментарии из функции в doxygen?

Мне интересно знать, возможно ли иметь некоторые комментарии в функции (c, C++, Java) способом, что doxygen мог поместить их в сгенерированный файл HTML. например: функция (...) {do_1 (); / **...
вопрос задан: 16 April 2009 21:18
4
ответа

Комментарии Документации XML с Интерфейсами и [закрытым] классом (классами) с реализацией

Я документирую блок с помощью Комментариев Документации XML, из которых файл председателя будет создан с помощью Замка из песка. Мой блок содержит различные интерфейсы, каждый из которых реализован одним...
вопрос задан: 15 April 2009 08:59
4
ответа

Документация относительно сжатия / методы распаковки

Я закончил свой текущий проект "с частичной занятостью", и ищу что-то новое. Я решил иметь трещину при записи моего собственного сжатия / утилита распаковки. Я не планирование продажи его или...
вопрос задан: 27 February 2009 00:28
4
ответа

Каково различие между//и///в Visual Studio?

Stylecop говорит мне использовать///вместо//, когда я комментирую. Каково семантическое различие для тех двух и когда я должен использовать который?
вопрос задан: 18 February 2009 00:58
4
ответа

Где я могу найти ASP документацией MVC? [закрытый]

Мог кто-либо может сказать мне, где я могу найти полный ASP.NET бета документацией MVC?
вопрос задан: 10 January 2009 00:27
4
ответа

Действительно ли возможно получить предупреждения из javadoc, когда что-то отсутствовало в комментариях Javadoc?

Случайно я могу забыть описывать некоторые параметры или бросок исключения (или что-то еще) при документировании методов или классов и т.д. Действительно ли возможно выполнить javadoc таким способом, которым это предупреждает меня...
вопрос задан: 27 October 2008 06:50
4
ответа

Лучший способ зарегистрировать Ajax + код PHP? [закрытый]

Я всегда был для документирования кода, но когда дело доходит до Ajax + PHP, это не всегда легко: код действительно распространен! Логика, данные, представление - Вы называете его - разделены и смешаны между...
вопрос задан: 6 October 2008 01:48
3
ответа

Использование Cucumber или RSpec + Selenium для создания документации для конечного пользователя? [закрыто]

Кто-нибудь пытался создать конечную пользовательскую (потенциально онлайн, потенциально печатную) справку / документацию из ваших сценариев огурца? Или снятые скриншоты для использования в документации с использованием RSpec и ...
вопрос задан: 22 December 2018 11:50
3
ответа

Руководство начинающего для [закрытого] Apache ServiceMix

Что полное руководство должно запустить с Apache ServiceMix? Практическое руководство и руководства по веб-сайту, слишком усложняют для чистого запуска.
вопрос задан: 28 September 2018 21:52
3
ответа

JSDoc добавление реального кода в документации

Вы знаете, существует ли своего рода <код/> тег в JSDoc? Я должен добавить части кода в моей документации как это: / ** * Эта функция делает что-то видит пример ниже: * * var x = нечто ("...
вопрос задан: 13 May 2018 09:32
3
ответа

Как использовать встроенные комментарии для документирования участников в.NET?

Как я могу зарегистрировать участника, встроенного в .NET? Позвольте мне объяснить. Большинство инструментов, которые извлекают документацию из комментариев, поддерживает некоторую встроенную документацию, где можно добавить резюме после участника...
вопрос задан: 19 January 2018 22:10
3
ответа

Javadoc как документация для [закрытых] XML-комментариев C#

Я ищу что-то для превращения моих XML-комментариев C# в документацию. Мне не нравится CHM, ни стиль MSDN. Я люблю использовать javadocs. По ним легко переместиться, и все доступно....
вопрос задан: 24 December 2017 21:51
3
ответа

Наследуйте docstrings в [закрытом] наследовании классов Python

Я пытаюсь сделать некоторое наследование классов в Python. Я хотел бы, чтобы каждый класс и наследованный класс имели хорошие docstrings. Таким образом, я думаю для наследованного класса, я хотел бы его к: наследуйте базовый класс...
вопрос задан: 12 December 2017 11:17
3
ответа

Doxygen: сокрытие частного / защищенного метода … и [закрытые] подсказки

Я использую Doxygen для генерации документации для нашего API, записанного в C#. Однако это подвергает частных/защищенных участников. Существует ли способ скрыть их? Я выяснил, как скрыть файлы: ИСКЛЮЧИТЬ...
вопрос задан: 28 July 2016 19:50
3
ответа

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

Править: Это - технически 2 вопроса о части. Я выбрал лучший ответ, который касается вопроса в целом и связанный с ответом, который обрабатывает конкретный вопрос. К чему лучший способ...
вопрос задан: 13 January 2016 10:30
3
ответа

Где официальная, обширная, подробная документация на web.config? [закрытый]

Я пытаюсь найти обо ВСЕХ возможных вариантах, что я могу установить в web.config. Удивительно, я не могу найти это вообще. Я ожидал, что это будет где-нибудь в MSDN. Я знаю, что могу технически добавить "...
вопрос задан: 1 September 2015 08:36
3
ответа

Как я могу использовать Сфинкса' Расширение автодокумента для закрытых методов?

Я использую Сфинкса для документирования моего проекта Python. Мне включили расширение автодокумента и имею следующее в моих документах... автокласс:: ClassName: участники: проблема, это только документы...
вопрос задан: 10 July 2015 23:36
3
ответа

jQuery [закрытая] Палитра цветов UI

Я услышал, что jQuery UI включает Палитру цветов, но мог найти мало документации относительно него. Это существует? Какая-либо достойная документация относительно того, как реализовать его? Я нашел это: http://docs....
вопрос задан: 6 July 2015 11:10
3
ответа

Список свойств Java Swing UI? [закрытый]

Кажется, существует тонна свойств UI, которые могут быть установлены с UIManager.put ("ключ", значение); существует ли список где-нибудь всех ключей, которые могут быть установлены?
вопрос задан: 1 November 2014 05:44
3
ответа

Шаблонная обработка сфинкса

Я использую сфинкса. Я хочу обработать его по шаблону. Таким образом, после чтения документов, что я пробую, в моем conf.py, я поместил строку как, templates_path = [' _templates '], и я создал файл _templates/page....
вопрос задан: 18 July 2011 17:08
3
ответа

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

Это - довольно лишний и неинтересный вопрос, я боюсь, но я всегда задаюсь вопросом об этом. Когда Вы прокомментируете код со встроенными комментариями (в противоположность комментариям, которые появятся в...
вопрос задан: 7 June 2010 12:39
3
ответа

WYSIWYG в Doxygen

Я работаю над довольно большим проектом, написанным на C. Идея заключалась в том, чтобы создать библиотеку модульных блоков, которые можно использовать на нескольких платформах. Каждый модуль связан с документом Word в ....
вопрос задан: 31 May 2010 12:56
3
ответа

Java: дата JPQL функционирует для добавления периода времени к другой [закрытой] дате

ВЫБЕРИТЕ x ИЗ SomeClass, ГДЕ x.dateAtt МЕЖДУ CURRENT_DATE И (CURRENT_DATE + 1 МЕСЯЦ) В вышеупомянутом операторе JPQL, SomeClass имеет memebr dateAttr, который является java.util. Дата и имеет @Temporal (...
вопрос задан: 18 May 2010 10:55
3
ответа

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

У меня есть последовательность изображений JPG. Каждое из сканирований уже обрезается к точному размеру одной страницы. Они - последовательные страницы ценной и распроданной книги. Приложение публикации требует...
вопрос задан: 12 April 2010 00:02
3
ответа

как упростить процесс документации кода - Visual Studio C#

Я задаюсь вопросом, существует ли какой-либо ярлык в Visual Studio для генерации автоматической документации для метода или класса. Например, когда я пишу метод: общественность освобождает MyFunction (интервал d) {}, я хочу...
вопрос задан: 25 March 2010 12:35
3
ответа

Замена [закрытых] docstrings Python

Я записал epytext для отдыха преобразователя разметки, и теперь я хочу преобразовать все docstrings в своей всей библиотеке от epytext для отдыха формата. Есть ли умный способ считать все docstrings...
вопрос задан: 19 March 2010 14:12
3
ответа

как зарегистрировать пакет Python

Я знаю то, что является стандартным способом зарегистрировать функции, классы и модули, но как делают я документирую пакеты - делают я вставил docstring __ init __. py или что-то еще?
вопрос задан: 7 March 2010 11:54
3
ответа

Управление ЛАТЕКСОМ Doxygen производится для того, чтобы сделать документацию в формате PDF

Я использую Doxygen для генерации документации для моего кода. Я должен сделать версию PDF из этого, и ЛАТЕКСНЫЙ вывод Doxygen использования, кажется, способ сделать это. Однако я столкнулся со многими...
вопрос задан: 28 February 2010 00:11
3
ответа

Представление / explaing код и проектные решения [закрытым] членам команды

Я работаю над проектом, где я должен буду регулярно выравнивать по ширине и объяснять свой код и проектные решения членам команды, которые непосредственно не вовлечены в ту же область проекта как я Как...
вопрос задан: 17 February 2010 05:30