0
ответов
Sphinx и JavaScript Документация Рабочий процесс [закрыт]
Для моей JavaScript структуры я хотел бы использовать Sphinx. Поскольку я новичок в мире Sphinx, я хотел бы, чтобы вы помогли мне начать работу с Sphinx и JavaScript. Любая помощь будет принята с благодарностью. ...
вопрос задан: 28 December 2011 03:57
0
ответов
Убедитесь, что свойство не может возвращать значение null [closed]
Возможно ли это в C # узнать из документов MSDN, что какой-то метод / свойство / поле может или НЕ может возвращать нулевое значение? например Свойство Image.RawFormat из MSDN говорит: ImageFormat, который представляет ...
вопрос задан: 27 December 2011 10:48
0
ответов
Как писать комментарии C ++, которые отображаются в Intellisense?
Я программирую на C ++ с помощью Visual Studio 2010 Ultimate. Я хочу задокументировать некоторые функции, и я хочу, чтобы документация отображалась в Intellisense. Согласно MSDN, мне просто нужно поставить комментарий ...
вопрос задан: 23 December 2011 05:48
0
ответов
Современная справочная система для приложений Windows [закрыто]
В настоящее время я занимаюсь редизайном старого приложения Windows-Desktop. Одна из целей редизайна - реализовать современный интерфейс в стиле Office2010 с лентами.
В дополнение к нашему пользовательскому интерфейсу мы хотим ...
вопрос задан: 21 December 2011 15:01
0
ответов
Code Contracts + Sandcastle - Можно ли настроить раздел исключений?
Я использую Code Contracts ver: 1.4.40602.0
Я скопировал необходимые файлы Content и Transforms
Sandcastle выводит исключения на основе требований моего контракта. Пример кода: открытый класс MyClass.
...
вопрос задан: 13 December 2011 19:42
0
ответов
Как добавить всплывающую подсказку документации к классам, методам, свойствам и т. Д. В C #?
Не уверен, что я вообще называю это правильно, но я хотел начать добавлять некоторую документацию к своим классам, методам , свойства и т. д. Я знаю, что это, вероятно, очень очевидно, но я так и не научился этому. Я'...
вопрос задан: 1 December 2011 20:59
0
ответов
Получение «плоского» вывода элементов для autodoc sphinx
Я использую расширение Autodoc Sphinx для документирования модуля, и я хотел бы получить плоский список элементов модуля в выходных данных документации. Я пробовал использовать следующее: .. automodule :: modname
...
вопрос задан: 30 November 2011 07:14
0
ответов
Как я могу настроить Sphinx для условного исключения некоторых страниц?
При создании документации с помощью Sphinx я хотел бы иметь возможность создавать две версии моей документации: одну, включающую все, и одну только с определенным набором страниц . Что за ...
вопрос задан: 29 November 2011 16:45
0
ответов
Встроить редактор документов Google на веб-страницу? [закрыто]
Можно ли встроить редактор Документов Google, чтобы он читал файл, который затем загружался на сервер (не сервер Документов Google), и вы могли редактировать его и сохранять обратно в тот же файл?
вопрос задан: 22 November 2011 12:11
0
ответов
Сохранение встроенного кода внутри ссылок в Sphinx
В Sphinx, если у меня есть следующее объявление заголовка: .. _somestuff: `this is code`, это не так!
===== ========================= Он отображает примерно так: это код ...
вопрос задан: 11 November 2011 20:13
0
ответов
Замок из песка / ШФБ. Добавляйте значки платформ и информацию о версии на страницы файлов справки
Я создаю файл справки для своей библиотеки с помощью Sandcastle Help File Builder. У библиотеки есть три версии (.NET, Silverlight и Windows Phone 7), построенные на одной и той же кодовой базе. Я хотел бы добавить ...
вопрос задан: 9 November 2011 18:58
0
ответов
Как задокументировать тип утки?
У меня слишком много документации, так как каждый раз, когда я сталкиваюсь со сложным типом утки, мне нужно каким-то образом сказать «этот тип утки», но вместо этого я попадаю в бесконечную цикл «ваша функция требует этого из ...
вопрос задан: 9 November 2011 03:30
0
ответов
Как создать документацию по sphinx для проекта django
У меня есть проект django, который я задокументировал с помощью reST в строках документации, чтобы сделать следующее: Помогите diagloags в среде IDE
Позже для создания документации HTML с помощью Sphinx My документация отображается правильно ...
вопрос задан: 14 October 2011 18:53
0
ответов
autodoc sphinx: как ссылаться на классы в одном модуле?
Я пытаюсь использовать расширение sphinx autodoc и, в частности, директиву automdule для автоматического создания документации для приложения django, над которым я работаю. Проблема в том, что я хочу создать ...
вопрос задан: 14 October 2011 13:11
0
ответов
Нужны ли строки документации для внутренних функций (Python)? [closed]
В Python мы обозначаем внутренние функции / частные методы с подчеркиванием в начале. Следует ли задокументировать эти функции с помощью строк документации (требуется ли это?)? (формальная документация, я имею в виду ...
вопрос задан: 7 October 2011 12:42
0
ответов
Где найти документацию по jain-sip [закрыто]
Название предельно ясно. Я ищу документацию по jain-sip, но не могу ее найти. На сайте jsip.java.net есть ссылка на документацию, но я получаю послание в hudson ...
вопрос задан: 6 October 2011 09:47
0
ответов
Добавление XML-документации / комментариев к свойствам / полям в классах, сгенерированных EF
У меня есть привычка комментировать свойства и классы в стандартной XML-документации, что это означает / что они делать. Но в классах, сгенерированных EF, конечно, все это исчезло, когда я регенерировал ...
вопрос задан: 6 October 2011 09:46
0
ответов
Тег строки документации для ключевого слова yield
В Python есть несколько тегов для строк документации, например @param и @return, например: def my_method (a_param): '' '@param a_param: Описание этого параметра @ return: возвращаемое значение ...
вопрос задан: 4 October 2011 18:39
0
ответов
YARD: документировать пользовательскую пару getter/setter как attr_accessor
Я использую YARD для документирования своего проекта. YARD документирует атрибуты, созданные с помощью attr_accessor :some_attribute в отдельном разделе "Instance Attribute Summary". теперь у меня есть другой атрибут, но с ...
вопрос задан: 28 September 2011 12:25
0
ответов
Правила / рекомендации по документированию кода C #? [закрыто]
Я относительно новый разработчик, и мне поручили документировать код, написанный опытным разработчиком C #. Мой босс сказал мне просмотреть его и задокументировать, чтобы он был ...
вопрос задан: 23 September 2011 22:58
0
ответов
Код формата в Doxia Apt Format
В настоящее время я начинаю писать документацию для одного из наших проектов. Из соображений простоты мы выбрали формат Almost Plain Text (APT) Format, подробнее смотрите здесь: http://maven.apache.org/....
вопрос задан: 22 September 2011 14:20
0
ответов
Автоматически создавать фиктивную документацию в исходном коде для Python в eclipse
В то время я документирую большую часть своего кода (Python), и мне было интересно, есть ли плагин в Eclipse, который может автоматически генерировать строку документации для моих функций, как это делает Visual Studio для ...
вопрос задан: 21 September 2011 13:31
0
ответов
генерируют диаграммы для HASKELL Code [Закрыто]
Есть ли что-то, что между GraphMod и Addock? Я хочу диаграмму, такой как GraphMod, показываю зависимости / отношения, но я хочу включить дополнительную документацию в ...
вопрос задан: 15 September 2011 12:31
0
ответов
Как переместить спрайт в направлении Fling/Swipe (по диагонали) с помощью AndEngine
Я работаю над игрой в AndEngine. Таким образом, можно переместить объект справа налево, сверху вниз и наоборот. Но моя проблема в том, что как я могу переместить объект Sprite в направлении...
вопрос задан: 6 September 2011 13:12
0
ответов
Использование Doxygen для создания документации для существующего кода C # с помощью XML Comments
Я прочитал везде, что Doxygen - это способ перейти на генерацию документации для кода C #. У меня есть один интерфейс, который я хочу задокументировать сначала (детские шаги), и у него уже есть XML ...
вопрос задан: 31 August 2011 13:27
0
ответов
Документирование веб-служб ServiceStack [закрыто]
Каковы параметры для документирование ServiceStack базируется на веб-сервисах, и я не говорю об однострочной строке. Я хотел бы иметь возможность подробно задокументировать (что может быть длинным), возвращаемые типы, ...
вопрос задан: 26 August 2011 02:09
0
ответов
PHPdoc: Skjalfesta keðjanlegar aðferðir?
Hvernig ætti ég að nota PHPdoc almennilega til að skjalfesta keðjanlegar aðferðir í bekk, eins og sést í dæminu hér að neðan - hver er rétt notkun myClass {/ ** * @ return myClass * / function ...
вопрос задан: 25 August 2011 09:21
0
ответов
Может Doxygen обрабатывать страницы, отличные от MainPage.dox
Если вы поместите файл MainPage.dox в путь поиска Doxygen, он добавит его к выходным данным в Doxygen / html над исходной документацией . Но можно ли иметь несколько файлов, например MainPage.dox? Или ты ...
вопрос задан: 22 August 2011 17:31
0
ответов
Как сгенерировать документы для моих моделей и контроллера в рельсах
I хочу создать документы для моделей и контроллера моего приложения. Даже для грабли, любой фоновой работы. Поскольку у меня есть тысячи строк комментариев, встроенных между кодом, объяснение всего ...
вопрос задан: 19 August 2011 17:32
0
ответов
Как ссылаться на методы экземпляра в документации?
Как я могу ссылаться на поле экземпляра при написании документации? Рассмотрим этот код: object Foo {val foo = 42
} class Foo {val foo = 42
} В Java можно использовать Foo.foo для «статики» ...
вопрос задан: 7 August 2011 13:05