Вопросы с тегом 'documentation'

ЭТОТ ТОГ ТОЛЬКО ДЛЯ ГЕНЕРАТОРОВ ДОКУМЕНТА. Включите язык и/или тег SDE. НЕ ИСПОЛЬЗУЙТЕ, чтобы запрашивать ссылки на документацию или инструменты или критиковать документацию поставщика.
2

pandas документация по перепрограммированию

Таким образом, я полностью понимаю, как использовать resample, но документация не делает хорошую работу, объясняя варианты. Поэтому большинство опций в функции resample довольно просты, за исключением следующих двух: правило: строка смещения или о...
08 июн. '13 в 16:09
17

Какие инструменты используются для написания документации?

Какие инструменты используются для написания документации? В частности, для Документы пользователя Системное администрирование Разработка Я ищу программное обеспечение таких MS Word, wiki, TeX (LaTeX, LyX) и для автоматизированных инструментов.
15 авг. '08 в 17:49
7

Документация API WebDriver (Selenium 2)

Я не могу найти официальную ссылку API class/method/properties для WebDriver в любом месте, только 5-минутный путеводитель и Next Step страницы, расположенные в seleniumhq, а также несколько других случайных описаний. Существует ли это?
13 апр. '11 в 5:39
12

Примеры документов требований

Мне было интересно, может ли кто-нибудь предоставить мне некоторую информацию о том, что они ввели в документе требований, как вы его структурируете? Я веду в первый раз, и я хочу убедиться, что я предоставляю хорошие документы, чтобы проект был успе...
05 окт. '08 в 7:59
8

Как документировать выброшенные исключения в С#/. Net

В настоящее время я пишу небольшую структуру, которая будет использоваться внутри других разработчиков внутри компании. Я хочу предоставить хорошую информацию Intellisense, но я не уверен, как документировать заброшенные исключения. В следующем при...
20 янв. '09 в 13:39
12

Лучшее размещение вики-решения для личных вики-проектов?

Ранее я спросил о как люди организовывают свои онлайн-ресурсы и исследуемые данные, где один из предлагаемых инструментов использует частную вики. Я хочу попробовать это, и поэтому я ищу размещенную wiki, где я могу хранить свои мысли, идеи и проект...
27 сент. '08 в 9:44
10

Почему встроенные функции в PHP называются так случайным образом?

Кажется, что нет никакого реального шаблона для того, как названы функции, str_replace, strrpos, strip_tags, stripslashes - только некоторые. Почему это так? EDIT - это не означало, что это сообщение типа "тролль" - это то, что я думаю каждый раз, ...
29 сент. '08 в 21:00
7

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

Как документировать методы с параметрами, используя строки документации Python? РЕДАКТИРОВАТЬ: PEP 257 дает этот пример: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) ...
08 февр. '12 в 14:41
14

Предложения для хорошего сообщения о фиксации: формат/ориентир?

Я нахожусь в начале нового проекта, и я пытаюсь настроить хранилище умным способом и установить некоторые правила стиля кода, чтобы каждый мог сконцентрироваться на коде. Большая часть из них выполняется, но я все еще не уверен в том, какой формат д...
04 сент. '08 в 12:17
5

Документация по FFmpeg C API/учебное пособие

Я пытаюсь найти документацию для использования FFmpeg C API. Кажется, что доступна только документация командной строки. Есть ли хорошая документация/учебные пособия/ссылки доступны?
14 апр. '10 в 22:17
9

Создание документации из XML-комментариев С#

Недавно я начал новый проект, и я впервые использую С#. Я обнаружил, что, хотя Visual Studio помогает создавать комментарии С# XML для документирования ваших классов и методов, вы не можете сделать так, чтобы создавать документы MSDN или Javadoc. Go...
07 сент. '08 в 12:34
27

Является преемником для TeX/LaTeX в поле зрения?

TeX/LaTeX отлично, я использую его разными способами. Некоторые из его преимуществ: он использует текстовые файлы, таким образом, входные файлы могут быть разными, и многие инструменты существуют для работы с текстом он очень гибкий. У него стаби...
19 нояб. '08 в 23:59
4

Как создать аннотированный исходный код, например, underscore.js?

Мне очень нравится аннотированный исходный код, который сопровождает библиотеку underscore.js: Как они это сделали? Есть ли script, который вытащит код комментарии и автосоздание такого рода документации html?
16 дек. '10 в 15:59
2

Что добавить в docstring модуля python?

Хорошо, поэтому я прочитал как PEP 8 и PEP 257, и я написал много docstrings для функций и классов, но я немного не уверен, что должно идти в модуле docstring. Я решил, что, как минимум, он должен документировать функции и классы, которые экспортируе...
31 мар. '10 в 23:04
10

RESTful JSON API Documentation Generator

Мне интересно, есть ли у кого-нибудь опыт или рекомендации для инструментов, которые могут использоваться для создания веб-страниц, которые документируют и позволяют вам играть с RESTful JSON API. Я думаю о чем-то вроде API разработчика Github или Go...
13 дек. '11 в 22:04