4
ответа
Как автоматизировать документацию API REST (Реализация Джерси) [закрытый]
Я записал довольно обширному REST API с помощью Java Джерси (и JAXB). Я также записал документацию с помощью Wiki, но его полностью ручной процесс, который очень подвержен ошибкам...
вопрос задан: 25 July 2018 02:05
4
ответа
Как генерировать документацию путем выполнения команды с каждой фиксацией svn
Действительно ли возможно заставить svn выполнить некоторую команду перед каждой фиксацией? Я имею некоторую документацию в ЛАТЕКСЕ в репозитории и хотел бы иметь всегда последнюю версию скомпилированных документов, доступных как...
вопрос задан: 26 January 2018 02:28
4
ответа
Как документировать код Python с помощью Doxygen [closed]
Мне нравится doxygen для создания документации кода на C или PHP. У меня есть предстоящий проект Python, и я думаю, что я помню, что Python не имеет / * .. * / комментариев, а также имеет свою собственную документацию ...
вопрос задан: 16 January 2018 20:07
4
ответа
документация API и “пределы значения”: они соответствуют?
Вы часто видите в документации API (как в 'javadoc государственных функций', например) описание "пределов значения", а также классическую документацию?Примечание: Я не говорю о комментариях...
вопрос задан: 23 May 2017 12:25
4
ответа
Есть ли API в .NET для чтения [закрытого] файла документации по комментариям XML
В этом вопросе я вижу, что Microsoft поставляет файлы документации XML для BCL. Интересно, знает ли кто-либо, если там API в .NET, который может использоваться для поиска этого во времени выполнения. Я знаю, что мы можем...
вопрос задан: 23 May 2017 12:24
4
ответа
Генератор шаблона Javadoc [закрывается]
У меня есть большая кодовая база без Javadoc, и я хочу запустить программу для записи скелета с основной информацией о Javadoc (например, поскольку параметр каждого метода пишет @param...), таким образом, я просто должен заполниться...
вопрос задан: 6 January 2016 14:05
4
ответа
Документация быстрого запуска WPF [закрывается]
Я полностью плохо знаком с WPF и поиском хорошей документации быстрого запуска для запуска с. Я куплю книгу WPF, Развязанный от Adam Nathan, но это - больше ссылка, чем быстрый запуск, я думаю. Я просто...
вопрос задан: 4 May 2015 21:52
4
ответа
Почему разработчики используют “Печаль Lorem Ipsum” для заполнения пространства? [закрытый]
Почему традиционно использовать латинскую псевдолатынь на страницах в качестве примера? Фактическое гипотетическое содержание слишком сбивает с толку? На этой странице I документации snarfed блоки текста из Википедии - делает это делает...
вопрос задан: 21 July 2011 17:43
4
ответа
Ruby on Rails и Ruby on Rails офлайновая [закрытая] документация API
В прошлом я использовал railsbrain.com, чтобы иметь хорошую и удобную офлайновую документацию API. Но они останавливаются в версии 2.3.2, там любое другое решение с последней версией.
вопрос задан: 16 March 2011 23:40
4
ответа
Документация Perl (POD) браузеры? [закрытый]
Я ищу, хороший экранный опыт чтения POD. В течение многих лет я использовал perldoc или человека, работающего в xterm для чтения документации Perl относительно экрана и маленькой пользовательской программы, созданной вокруг Переходной приставки::...
вопрос задан: 25 September 2010 18:15
4
ответа
C ++: где писать код документации: в .cpp или in. hpp файлы? [закрыто]
Где обычно пишется документация классов и методов в коде? Вы пишете такие doc-блоки над соответствующим классом / методом в файле заголовка (.hpp) или внутри исходного кода (...
вопрос задан: 26 August 2010 07:11
4
ответа
Существует ли стандартный стиль для документации в PHP? [закрыто]
Я новичок в разработке PHP, и мне интересно, есть ли у сообщества какие-либо руководящие принципы для встроенной документации кода с использованием комментариев. Я хотел бы что-то вроде PEP 257 Python, но я бы согласился на ...
вопрос задан: 28 June 2010 20:06
4
ответа
Документация для спокойных комментариев для документации? QT + Doxygen? [закрытый]
Где я могу найти документацию для спокойных комментариев для документации? Я обращаюсь к как спокойное использование определенный стиль для комментариев для документации, как так: /*! \class MyClassName \brief MyClassName...
вопрос задан: 17 June 2010 05:10
4
ответа
исключения автодокумента на методах в [закрытом] C#/.NET
Я хотел бы некоторый инструмент, предпочтительно тот, который включает VS 2008/2010, который пройдет мои методы и добавит XML-комментарии о возможных исключениях, которые они могут выдать. Я не хочу <сводка>...
вопрос задан: 7 June 2010 13:40
4
ответа
Генератор документации C++ Visual Studio [закрывается]
Существует ли способ получить документацию (как javadoc) в проекте Visual C++? Я использую Visual Studio 2010.спасибо!
вопрос задан: 15 May 2010 14:43
4
ответа
Документирование функций в C ++ с помощью Doxygen [closed]
У меня есть проект, для которого я использую Doxygen для генерации документации. Документация классов хорошая, но у меня также есть некоторые функции, которые я использую в main () для создания объектов и т. Д. Я также ...
вопрос задан: 8 May 2010 12:33
4
ответа
Существует ли категорический справочный документ для синтаксиса Ruby? [закрытый]
Я ищу категорический документ о синтаксисе Ruby. Я знаю о категорических документах для базового API и стандартной библиотеки, но что относительно самого синтаксиса? Например, такой документ...
вопрос задан: 2 May 2010 19:32
4
ответа
Как отследить проекты посторонние причуды
Возможно, что ответ на этот вопрос может просто быть стандартным программным обеспечением отслеживания ошибок как jira или fogbugz, но я - вид надежды, что кто-то там знает лучшую систему для того, что я описываю...
вопрос задан: 27 April 2010 10:43
4
ответа
Комментарий C код, заголовочные и [закрытые] исходные файлы
Я ищу "лучшую практику" для документирования моего кода C. Как в каком-либо проекте у меня есть некоторые заголовочные файлы ".h" и соответствующий исходный файл ".c" В заголовочном файле, какой комментарий Вы вставляете? И..
вопрос задан: 7 April 2010 11:37
4
ответа
Как справиться с управлением версиями документации программного обеспечения и самого программного обеспечения? [закрытый]
Мне нужны некоторые события относительно записи документации программного обеспечения и руководств пользователя. Когда я пишу формальные документы как требования к программному обеспечению, каждый документ получает номер версии и в...
вопрос задан: 2 March 2010 08:52
4
ответа
Где я могу просмотреть исходный код для libc онлайн (как doxygen) [закрытый]
Иногда я хочу искать реализации функций в stdlib, я загрузил исходный код, но это довольно грязно. Просто хватание не действительно подходит из-за многих хитов. Делает...
вопрос задан: 30 December 2009 05:10
4
ответа
УСПОКОИТЕЛЬНАЯ документация API [закрывается]
Я собираюсь разработать УСПОКОИТЕЛЬНЫЙ API скоро, таким образом я должен описать его, чтобы позволить другим людям начать реализовывать клиенты, использующие его. Я озирался немного, но к сожалению, я не нашел...
вопрос задан: 27 December 2009 06:26
4
ответа
Документация библиотеки стандарта SBCL? [закрытый]
Я хочу изучить и использовать SBCL из-за его простоты изучения и скорости. (Я играл с Lisp 3 года назад, и теперь обновляю его.), Но как может, я изучаю то, что включено в стандартную библиотеку...
вопрос задан: 8 December 2009 13:25
4
ответа
Что хорошие и плохие пути состоят в том, чтобы зарегистрировать проект программного обеспечения? [закрытый]
Я ответственен за нахождение хорошего способа зарегистрировать проект программного обеспечения, я продолжаю работать. Какие вещи важны для документа? Если документация кода и дизайна главным образом находится в коде в...
вопрос задан: 25 November 2009 11:32
4
ответа
Как заставить Java API Javadocs обнаруживаться в Eclipse в Ubuntu
Я здесь снова с вопросом о документах. В моем университете, при использовании Eclipse, при установке курсора на Java имя метода API (например: .size ()), я получаю очень хорошую документацию об этом. Здесь...
вопрос задан: 5 November 2009 04:05
4
ответа
Лучшая ссылка Повышения? [закрытый]
Вещью, которая действительно выключает меня о Повышении, является их документация. То, в чем я нуждаюсь, является хорошей ссылкой, и вместо того, чтобы объяснить, что хорошая ссылка мне, я дал бы пример: java.sun.com/...
вопрос задан: 9 October 2009 14:30
4
ответа
Спецификация байт-кода Lua [закрыто]
Может кто-нибудь сказать мне, где найти спецификацию байт-кода Lua? Я искал 15 минут, и я ничего не могу найти.
вопрос задан: 26 September 2009 07:30
4
ответа
документация python win32 расширений [закрывается]
Я плохо знаком с Python и для расширениями python win32, доступными по http://python.net/crew/skippy/win32/, но я не могу найти документацию онлайн или в каталогах установки относительно какой...
вопрос задан: 24 September 2009 05:48
4
ответа
Как записать техническую документацию веб-сайта / программное обеспечение для новых разработчиков? [закрытый]
Я хочу сделать техническую документацию существующего веб-сайта для разработчиков так, чтобы новые разработчики могли продолжить работать с ним. В существующих кодах, мало (или нисколько) в комментариях к коду или документ-...
вопрос задан: 1 September 2009 06:32
4
ответа
Используя Doxygen с C, Вы комментируете прототипа функции или определение? Или оба?
Я использую Doxygen с некоторыми, встроил источник C. Учитывая .c/.h пару файла, сделайте Вас, помещает комментарии Doxygen к прототипу функции (.h файл) или функциональное определение (.c файл) или делают Вы копируете их...
вопрос задан: 13 August 2009 22:46