有没有办法告诉Yard不要在我的Rails项目的doc/文件夹里弄乱?我希望它将文件保存在doc/yard/或类似的地方。可惜我没有找到任何选项来实现这一点。 谢谢您的帮助。
YARD允许我为方法参数和返回值指定类型。由于我非常喜欢鸭子类型,因此很高兴看到YARD还支持通过指定它们必须支持的方法来定义类型。 正如您在这里所看到的,像#first_method,#second_method这样的表达式被解释为逻辑析取。这意味着对象需要支持#first_method或...
我正在将我维护的一个Rubygem从RDoc文档转换为YARD文档。然而,代码中有一些关键性的注释需要只保留在代码中,不应该出现在文档中。例如: ## # SomeClass documentation here. #-- # CRITICAL comment that should be ...
我有一个典型的面向对象模式:一个基本抽象类(定义了抽象方法)和若干个类,这些类以特定的方式实现这些抽象方法。 我习惯于在抽象方法中只写文档,然后它自动传播到几个具体类(至少在Javadoc、Scaladoc、Doxygen中是这样),也就是说,我不需要在所有具体类中重复相同的描述。 然而,...
我有一个通过工厂函数创建的类,像这样: Cake = MyProject.Struct(:type, :price) 在Yard中,它与我的常量一起简单地显示: Cake = Struct(:type, :price) 我希望它能出现在“Classes:”列表中。阅...
我正在使用YARD来记录我的一个Ruby项目。我有一些方法不想包含在文档中,例如#inspect和#to_s这样的方法,你期望它们存在并返回合理的结果。 可以使用@private标签和yardoc --no-private命令行选项来隐藏这些方法: # @private let's not...
我可以将这个函数的文档翻译如下: ## # Searches for street names in the local address database. Returns a list # of strings, or invokes the block for each result. ...
在官方YARD文档中,有以下示例: 点击此处 查看。 # @overload set(key, value) # Sets a value on key # @param key [Symbol] describe key param # @param value [Object...
我正在使用yard生成我的项目文档。尽管文档可以生成,不一定需要进行版本控制,但我们决定这样做,因为这样可以更容易地看到代码(注释)在实际文档中的变化影响。 问题是每次yard生成文档时,它会更改每个文件开头的日期,导致所有文件都被视为已更改。 有没有办法告诉git忽略这些行以检测文件是否...