Я использую макросы в инструменте YARD doc, и на некоторых файлах они работают, а на некоторых нет. Например, я определяю макрос в одном из моих исходных файлов. # @macro [new] my_macro # @param [String] my_string it's a string! # def...

Я использую Ruby on Rails 3.1.0 и YARD 0.7.4 . gem для документации. Я реализовал работающий плагин (в каталоге ROOT_APP/vendor/plugins/<plugin_name> ) и хочу задокументировать этот плагин . Примечание . Когда я запускаю команду yard...

При попытке создать документацию YARD для службы, реализованной с помощью Rails, я получаю следующее предупреждение: $ yardoc [warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for...

Я скачал исходный код ruby ​​Twitter gem и пытаюсь сгенерировать документацию, используя yard, который я установил через gem install yard . В rakefile я нашел следующее, которое, как я полагаю, используется для создания документации для драгоценного...

Как создать ссылку на рубиновый метод класса с помощью YARD? Вот документация по верфи относительно ссылок. Ссылка на метод экземпляра в том же пространстве имен: {#my_instance_method} Который отлично работает. Однако, следуя тому...

Я задокументировал некоторый код Ruby с помощью YARD, и у меня возникли проблемы с получением документации YARD, которую я создал для некоторых методов в пространстве имен верхнего уровня, для отображения в HTML-выводе yardoc. Моя документация...

Хорошо, у меня есть задача, в которой я должен извлечь методы и комментарии из файла ruby ​​​​и сохранить их в БД в качестве ссылки. до этого мне удалось выделить этот фрагмент кода, чтобы добиться того же module Describe def...

Когда я добавляю новую индексную страницу в activeadmin, я пишу такой код: # A default activeadmin page for yard overview ActiveAdmin.register AdminUser do permit_params :email, :password, :password_confirmation index do column :email...

Я хотел бы включить информацию о задачах Rake в наше приложение Rails. Мы используем YARD для документации, и на данный момент такие страницы, как lib/tasks/development.rake , отображаются по умолчанию как неформатированный текст. Я могу...

Я использую yard для документации в своем проекте, но я не хочу показывать свой исходный код пользователям. Есть ли способ спрятать исходный код во дворе.

Существует отличный инструмент rustdoc (в настоящее время используется cargo ) для тестовые примеры комментариев к документации в Rust . Дает ли нам rdoc или yard что-то подобное в Ruby?

Я хочу, чтобы фрагмент кода, например хеш, отображался с фиксированным шрифтом в результирующем html. Предположим, это содержимое моего файла: =begin One example of valid hash to this function is: { :name => "Engelbert", :id =>...

Предположим, у меня есть следующее class AbstractClass; end class ConcreteClass1 < AbstractClass; end class ConcreteClass2 < AbstractClass; end Как задокументировать возвращаемое значение, которое возвращает экземпляр класса класса,...