У меня есть несколько драгоценных камней, установленных в нескольких местоположениях. Что является твердым / простым способом к generate/re-generate: rdoc для всех этих установленных драгоценных камней, внезапно? yardoc для всех этих установленных драгоце
Я любил использовать ДВОР много: http://www.ootl.org/yard/ http://code.google.com/p/yardparser/ http://www.codeproject.com/KB/recipes/yard-tokenizer.aspx я смог создать полностью функциональный...
Я хотел бы включить информацию о задачах Rake в наше приложение Rails. Мы используем YARD для документации, и на данный момент такие страницы, как lib / tasks / development.rake, по умолчанию отображаются в виде неформатированного текста. ...
Я пишу документацию для своего рубинового драгоценного камня, используя YARD. В моем драгоценном камне у меня есть некоторый код, который следует этому общему шаблону рубина, в котором модуль включен в класс, и этот модуль не только добавляет экземпляр .
Поправьте меня, если я ошибаюсь, это YARD не то же самое, что RDoc? Это не основано на RDoc, а полностью переписано? Так что, если я использую YARD, мне не нужно беспокоиться о RDoc, верно?
Есть ли способ сказать Yard, чтобы он не загромождал папку doc/ моего проекта Rails? Я бы хотел, чтобы он сохранял свои файлы в doc/yard/ или что-то в этом роде. К сожалению, я не нашел никакого варианта для этого. Спасибо...
Я только начинаю использовать YARD для документирования моего приложения Rails. Я не указал какой-либо конкретный обработчик разметки, но я ожидал, что `код `будет преобразован в код, чего, похоже, не происходит....
Я использую ярд для сгенерировать документацию моего проекта. Даже несмотря на то, что документацию можно сгенерировать и, следовательно, ее не нужно версионировать, мы решили сделать это, потому что это упрощает...
Я пытался задокументировать некоторый код Ruby, используя yardand, хотя я делаю именно то, что описано здесь или здесь #@param [Integer] количество испытаний (>= 0)
#@param [Float] успех...
YARD позволяет мне указывать типы для параметров метода и возвращаемых значений. Так как мне очень нравится уклоняться от набора текста, приятно видеть, что YARD также поддерживает определение типов путем указания методов, которые они должны поддерживать
Если я хочу увидеть документацию по своим драгоценным камням, я могу это сделать: ярд сервер --gems Как я могу см. документацию по стандартной библиотеке Ruby?
Я нахожусь в процессе перехода от RDoc к документации YARD для поддерживаемого мной rubygem. Однако в коде есть некоторые критические комментарии, которые должны оставаться только в коде и не должны ...
Я использую YARD для документирования своего кода. У меня есть метод, который имеет необязательный параметр со значением по умолчанию. Как отметить, что параметр является необязательным и имеет значение по умолчанию? Пример: # Квадраты ...
Я использую YARD для документирования своего проекта. YARD документирует атрибуты, созданные с помощью attr_accessor :some_attribute в отдельном разделе "Instance Attribute Summary". теперь у меня есть другой атрибут, но с ...
У меня есть небольшая библиотека кода, которую я документирую с помощью YARD. Когда я запускаю команду YARD, она сообщает мне: Files: 40
Модули: 14 (0 недокументированных)
Классы: 39 (0 ...
Я использую YARD для создания документов для моего приложения rails с makrdown в качестве парсера скриптов. Большинство функций документации просто отлично работают прямо из коробки. Однако я также хотел бы задокументировать ...
В настоящее время я перехожу с rdoc на ярд для моей документации по программному обеспечению ruby. В моем документе я часто ссылаюсь на некоторые классы / модули из комментариев, например: ## == Предоставляет различные утилиты ...