0
ответов
Django и Sphinx — как просмотреть HTML, который генерирует Sphinx?
Хорошо. У меня есть проект Django, который я хочу задокументировать, поэтому я установил Sphinx. Установка прошла нормально, и я могу вывести весь HTML-код в папку _build. Но... Вопрос в том, как мне на самом деле просмотреть...
вопрос задан: 23 May 2012 12:03
0
ответов
Многострочные строки документации Clojure
Я заметил, что многострочные строки документации Clojure в большинстве случаев форматируются вручную, в том числе и в clojure.core. Пример из https://github.com/clojure/clojure/blob/master/src/clj/...
вопрос задан: 23 May 2012 03:11
0
ответов
Авторитетный источник книги Марка Пилигрима «Погружение в Greasemonkey» [закрыто]
Учитывая, что Марк Пилигрим вытащил свое «Погружение в Greasemonkey» 06.10.2011, какой авторитетный источник для него? Я не хочу заходить на сайт, зараженный вредоносным ПО, чтобы получить его. Например, это www....
вопрос задан: 19 May 2012 09:46
0
ответов
Функции документа, определенные с помощью макроса в Doxygen
У меня есть класс, который на самом деле не существует, но определяется с помощью макроса: #define DEFCLASS(name,datatype) Имя класса { \ public: \ void clear(); \ объект типа данных; \ };
DEFMETHOD(...
вопрос задан: 12 May 2012 08:18
0
ответов
Каков стандарт стиля документации в сценариях Bash? [закрыто]
В настоящее время я пишу сценарий Bash, в котором есть несколько функций, и хотел бы добавить документы, чтобы другие члены команды поняли, в чем смысл функции. Существует ли стандарт "...
вопрос задан: 11 May 2012 14:17
0
ответов
Проблемы с Xcode, подсветка синтаксиса нарушена [дубликат]
У меня были проблемы с Xcode 4 (4.3.1 - 4E1019). Через несколько часов, а может и меньше, мой код не подсвечивается правильно, кажется, что Xcode теряет смысл Cocoa, и я получаю скриншот из примера, ...
вопрос задан: 11 May 2012 06:16
0
ответов
Документация по общедоступному API Sphinx
У меня есть большое количество файлов Python, и я хотел бы создать общедоступную документацию по API для своего проекта. Все функции, входящие в состав апи, я украсил декоратором. например :...
вопрос задан: 27 April 2012 11:49
0
ответов
Установка PHPDocumentor вручную на Mac
После безуспешной попытки установить PHPDocumentor с PEAR, я попробовал это вручную, как подробно описано на официальном сайте:http://www.phpdoc.org/docs/latest/for-users/installation.htmlЯ...
вопрос задан: 26 April 2012 18:02
0
ответов
Использование '\displaymath' директивы в строках документации формулы
Я использую пакет документации Sphinx для документирования небольшого набора инструментов Python, над которым я работаю, и я хотел бы описать математические формулы, которые реализуют различные модули, с помощью...
вопрос задан: 19 April 2012 13:48
0
ответов
Ссылки на статьи в пакете R с использованием roxygen2 и BibTeX?
Я использую roxygen2 в качестве инструмента для документирования моего R-пакета и обнаружил, что в roxygen2 есть тег @references, но, похоже, он принимает только текст в произвольной форме. Я нашел презентацию о...
вопрос задан: 18 April 2012 10:32
0
ответов
Документирование двух методов S3 в одном файле с помощью Roxygen
У меня есть два метода для универсального S3 (, определенные в другом пакете), которые тесно связаны между собой, поэтому я хотел задокументировать их в одном файле Rd.. Однако, когда я документирую их аргументы отдельно, я...
вопрос задан: 10 April 2012 19:55
0
ответов
Python Sphinx ссылается на длинные имена
Я работаю над документацией для своего модуля Python (используя Sphinx и reST), и я обнаружил, что при перекрестных ссылках на другие Python объекты (модули, классы, функции и т. д.), полное имя объекта заканчивается ...
вопрос задан: 6 April 2012 02:26
0
ответов
Документация по архитектуре lib2to3 [закрыто]
Я хочу почувствовать lib2to3, но не могу найти много в способ документирования. Было ли написано что-нибудь вроде обзора архитектуры? Где я могу найти больше информации о библиотеке?
вопрос задан: 2 April 2012 01:30
0
ответов
Отдельная документация от кода
Я не знаю, возможно ли это, но мне интересно, есть ли способ хранить код и документацию в отдельных файлах, но при этом работать так же, как обычно, со встроенной документацией..
вопрос задан: 17 March 2012 11:12
0
ответов
Лучший способ добавить документацию разработчика в ваши проекты Visual Studio [закрыто]
По сути, вопрос таков: где (и в каком формате) я должен хранить текстовую документацию разработчика, связанную с моими проектами Visual Studio? Уточним: XML-комментарии прекрасны, но они не...
вопрос задан: 16 March 2012 10:30
0
ответов
Требуется документация по протоколу XBoard (шахматы) [закрыто]
Я ищу документацию по XBoard. XBoard — это протокол связи между шахматными движками и шахматным графическим интерфейсом. Я знаю о http://www.gnu.org/software/xboard/engine-intf.html, но, похоже, пропустил...
вопрос задан: 10 March 2012 16:03
0
ответов
Обработка двух разных функций с одинаковым именем в Doxygen
У меня есть проект C, который содержит две функции с одинаковым именем, но каждая из них в другой группе / модуле (@defgroup). Каждая из этих функций компилируется в отдельный двоичный файл, но мне нужен ...
вопрос задан: 3 March 2012 18:33
0
ответов
Строки документов - одна строка против нескольких
Я добавляю некоторую (epydoc) документацию к написанному мной пакету, и я сталкиваюсь с множеством случаев, когда я повторяюсь множество раз. def script_running (self, script): "" "...
вопрос задан: 22 February 2012 09:25
0
ответов
Doxygen и добавить значение атрибута в выходную документацию
ServiceStack помечает оставшиеся пути для веб-служб с помощью атрибутов C #. Например [RestService ("/ hello1")]
[RestService ("/ hello2")]
публичный класс Здравствуйте, я хотел бы, чтобы Doxygen включал значения ...
вопрос задан: 16 February 2012 06:02
0
ответов
Генерация документации Javascript [закрыто]
Я изучаю документирование кода javascript, который мы разрабатываем, и ищу несколько хороших генераторов документации JavaScript. Есть ли у кого-нибудь предложения? Раньше мы использовали ndoc для создания ...
вопрос задан: 13 February 2012 15:21
0
ответов
Где должна храниться проектная документация в типичном проекте maven [закрыто]
Где должна храниться проектная документация (требования и т. Д.) В типичном проекте maven. Ни один из каталогов, перечисленных на странице "Введение в стандартную структуру каталогов", не является очевидным ...
вопрос задан: 3 February 2012 10:24
0
ответов
Документирование типов уток с несколькими методами в YARD
YARD позволяет мне указывать типы для параметров метода и возвращаемых значений. Так как мне очень нравится уклоняться от набора текста, приятно видеть, что YARD также поддерживает определение типов путем указания методов, которые они должны поддерживать
вопрос задан: 3 February 2012 10:02
0
ответов
Как писать комментарии к документации на ANSI C? [closed]
Я не могу найти, как писать комментарии на C. Я имею в виду, что знаю о // и / * * /, я имею в виду, где я могу найти передовой опыт? Например, если у меня есть функция, как мне написать, что переменная @param - это значение ...
вопрос задан: 28 January 2012 08:30
0
ответов
Как мне писать XML-комментарии, чтобы не повторяться между тегами сводки и возврата? [closed]
Когда цель метода - вычислить значение и вернуть его, я обнаружил, что документирую это следующим образом: ///
/// Подсчитывает количество виджетов.
///
///
вопрос задан: 26 January 2012 10:27
0
ответов
Как мне сделать ссылку на раздел документа в том же каталоге (pandoc markdown-> html output)
У меня есть два довольно простых куска документации (написанных в уценке, которая используется для создания HTML-файлов с помощью pandoc). Я хотел бы иметь возможность ссылаться на раздел второго документа из первого ...
вопрос задан: 22 January 2012 12:54
0
ответов
Как избавиться от параграфа "The documentation for this class was generated from the following files"?
Какую опцию и где она находится в GUI front end, мне нужно установить, чтобы убрать параграф The documentation for this class was generated from the following files: from my project documentation ....
вопрос задан: 16 January 2012 14:53
0
ответов
Как документировать структуры данных JavaScript/CoffeeScript
Я ищу описательный способ документировать используемые структуры данных в моем приложении JavaScript. Мне кажется, что это трудно сделать из-за динамического характера JavaScript. Например, что ...
вопрос задан: 14 January 2012 01:03
0
ответов
Генератор HTML-документации для .NET [закрыто]
Я ищу хороший генератор документации HTML для .NET. Sandcastle слишком сложный и слишком глючный для моих нужд, а NDoc был мертв уже много лет. Одно из моих требований заключается в том, что он также должен ...
вопрос задан: 13 January 2012 20:33
0
ответов
Почему я не вижу XML-комментарии из внешней библиотеки?
Это нормально, я не вижу XML-комментарии из внешних библиотек?
Например, у меня есть внешняя библиотека с комментариями XML к методам. После ссылки на эту библиотеку я надеялся, что xml ...
вопрос задан: 12 January 2012 12:30
0
ответов
Каков статус PHPDoc? [закрыто]
Раньше я никогда особо не заботился о документировании своего кода, но недавно я начал работать над проектом с открытым исходным кодом, и возникла необходимость. Очевидно, что «оружие выбора» - это PHPDoc, но ... Я действительно не мог ...
вопрос задан: 2 January 2012 05:30