Описание тега code-documentation

Вопросы с тегом
Документация, которая фокусируется на самом коде, таком как его функция, правильное использование, ожидаемый результат, связь с другим кодом, а также соединения с базой данных и таблиц, а также примеры использования.
1 ответ

NoMethodError: неопределенный метод `match?' для "Рубина": Строка

Я пытаюсь проверить, соответствует ли ввод пользователя RegEx [a-zA-z] поэтому я проверил документы для правильного метода. я нашел match? в Ruby-doc.org и скопировал пример, показанный в документах, в irb, но вместо true Я получаю это: 2.3.3 :001 &…
22 янв '17 в 14:50
1 ответ

Документация кода перестала работать в Xcode 6

Я ждал до 6.0.1, чтобы переключиться на Xcode 6. Открыв один из моих проектов, я заметил, что быстрое представление справки о методе или документации переменной больше не работает. Например простой: /*! Value of the property. */ для @property просто…
08 окт '14 в 23:51
1 ответ

Drupal через Eclipse для PHP - ошибки в документации кода

Я скачал Eclipse для разработчиков PHP, чтобы управлять кодом Drupal. С этой целью я изменил свои настройки Eclipse, следуя описаниям на этой странице, затем создал новый проект PHP и сослался на существующий проект Drupal на моем локальном веб-серв…
26 мар '18 в 13:09
1 ответ

Как добавить справочную документацию по методу в C# dll?

Я хочу добавить справку / документацию к библиотеке, которую я создаю в C#. Я использую /// для создания тегов, и это прекрасно работает, когда я использую методы моей библиотеки в моем проекте библиотеки. Например: если в моей библиотеке 2 класса C…
10 июл '15 в 15:18
0 ответов

Правильное место для документирования реализации сложного кода

Последние 3 месяца я работаю над сольным проектом в компании. Поскольку по большей части моя работа состояла из кодирования, я, естественно, сгенерировал некоторый объем кода (около 2000 строк), который я старался комментировать как можно деликатнее…
31 янв '19 в 08:14
1 ответ

Александрия Лисп Руководство и внедрение

Пакет ALEXANDRIA, кажется, широко используется в сообществе Common-Lisp. Тем не менее, единственная документация, которую я нашел, это черновая версия руководства, которая приводит к паре вопросов: 1) Есть несколько макросов, таких как reversef, кот…
10 фев '17 в 22:24
2 ответа

Установка вручную PHPDocumentor на Mac

После попытки установить PHPDocumentor с PEAR-установкой безуспешно, я попробовал это вручную, как подробно описано на официальном сайте: http://www.phpdoc.org/docs/latest/for-users/installation.html Я скачал файлы и сделал псевдоним для / usr / bin…
26 апр '12 в 18:02
1 ответ

python3, в тексте справки (int), что описываются дескрипторы данных?

Когда вы получаете строку справки для типов int, используя help(int). Самая последняя часть: | ---------------------------------------------------------------------- | Data descriptors defined here: | | denominator | the denominator of a rational nu…
13 сен '18 в 23:01
1 ответ

Понимание документации Android: обработка фрагментов среды выполнения "никогда не должна передавать объект, связанный с действием"

Я относительно новичок в программировании и у меня проблемы с изменением ориентации. Буду благодарен за любые мысли.Это конкретный вопрос об официальной документации Android, пожалуйста, не сообщайте об этом вопросе как о дубликате и покажите мне об…
03 окт '16 в 07:49
1 ответ

Как я могу заставить Doxygen показывать полный путь включения?

Как я могу заставить Doxygen показывать полный путь включения? Что я имею в виду: У меня есть класс foo::bar::bee определяется в bee.hpp в следующей структуре каталогов: foo foo/bar foo/bar/bee.hpp Doxygen, когда это документы foo::bar::bee класс го…
11 мар '10 в 05:30
0 ответов

Документация по функциям javascript

Новичок оповещения! Когда вам требуется модуль в вашем коде, такой как ниже, и вы наводите указатель мыши на функцию, которую вы вызываете из этого модуля, вы получаете всплывающее окно с некоторой документацией о функции, то есть параметрах, возвра…
28 ноя '18 в 21:17
0 ответов

Как документировать испускаемые сигналы Qt в doxygen?

Я знаю, что сигнал - это просто функция, поэтому проблема не в документировании самого сигнала. Представьте себе следующее тело функции bar(): void MyFooBar::bar(int x) { if(x < 0) emit fooLess(); else if(x > 0) emit fooGreater(); else emit fo…
15 фев '17 в 08:27
0 ответов

Документирование кода Kotlin: как создать таблицу?

Я прочитал эту статью о документировании кода Kotlin, а также эту статью. Я попробовал этот код: /** * | First Header | Second Header | * | ------------- | ------------- | * | Content Cell | Content Cell | * | Content Cell | Content Cell | */ И это:…
22 дек '18 в 10:32
2 ответа

Есть ли полная документация по Selenium Webdriver для NodeJS?

Кажется, я не нахожу ничего, единственное, что я всегда нахожу, это: https://code.google.com/p/selenium/wiki/WebDriverJs Но это больше руководство. Не документация всех функций. Например, не хватает документации для Webdriver.Windowили что-то вроде …
19 май '15 в 10:34
0 ответов

JSDoc: "Любой" заполнитель для объектов с похожей структурой, вложенных

Я пытаюсь документировать следующий объект: let x = { stopCP: { enabled: false, method: "POST", body: "STOP" }, startCP: { enabled: false, method: "POST", body: "START" }, restartCP: { enabled: false, method: "POST", body: "RESTART" }, viewLog: { en…
29 янв '19 в 13:31
1 ответ

Python urllib.request.Request параметр 'data' тип объекта

Я пытаюсь использовать urllib.request.Request (Python 3.6.7), чтобы вызвать API для внутренних веб-сервисов, чтобы получить некоторые результаты JSON. Мне нужно отправить некоторые данные и заголовки на сервер, поэтому я использую класс urllib.reque…
21 фев '19 в 08:18
0 ответов

Python urllib.request.urlopen возвращает тип объекта

Я использую Python (3.6.7) urllib.request.urlopen, пытаясь получить некоторый контент из HTTP-запроса к веб-серверу. Вот мой код: import urllib.request with urllib.request.urlopen(url='http://httpbin.org/get') as resp: ## do something Однако из этой…
22 фев '19 в 11:19
0 ответов

GhostDoc, как получить атрибуты свойства?

Я использую вышеупомянутый инструмент документации на Visual Studio 2017. Я могу добраться до GhostDoc Options > Rules > Property Template и настроить код. У меня есть свойство, как; [Display(Name="Text here")] [Required] public int CompanyId {get;s…
28 фев '19 в 14:08
1 ответ

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

Учитывая enum это имеет case с параметрами, как я могу документировать эти параметры? Например, эти комментарии к коду: /// Various coffee types. enum Coffee { /// A Cappuccino. /// - parameters: /// - cream: Is true if cream is added. case cappucci…
07 окт '18 в 14:48
1 ответ

Как включить внешний файл в документацию sphinx, похожую на блок кода?

Как включить внешний файл в документацию sphinx, похожую на блок кода? И как я могу заставить его стилизовать цвет синтаксиса?
21 ноя '15 в 11:49