个人中心
文章发布
退出
作者热门文章
- xml - AJAX/Jquery XML 解析
- 具有多重继承的 XML 模式
- .net - 枚举序列化 Json 与 XML
- XML 简单类型、简单内容、复杂类型、复杂内容
28
4
我正在尝试记录我在类里面使用 RDoc 注释编写的一些 rake 任务，但在表示方括号时遇到了麻烦。我想添加一些示例，说明如何使用参数运行我的 rake 任务，因此有一个像这样的 rdoc 行:
# 例如。 rake 构建[MyProject]
问题是 RDoc 解析器转换创建了一个链接而不是打印方括号。我尝试了各种转义序列:[ ; [[; ＃{[我的项目]} ; [我的项目]但似乎没有任何效果。
有什么方法可以转义这些方括号，使它们不会转换为链接吗？
谢谢，亚伦
最佳答案
通过进一步的实验，我发现了一种方法。如果我在每行前面放置两个空格，RDoc 会将这行视为预先格式化的文本并呈现括号。对我来说足够好了。
生成的 RDoc 行是:
# eg. rake build[MyProject]
关于ruby - 我如何在 RDoc 中表示方括号 ([])？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/4214726/
28
4
0
继承了一堆带有rdoc注释的Ruby代码，但是很多选项和属性都是多行的，比如: # +param+:: Here is a parameter with a really long descripti
每当我运行 make 时，我都会收到此“未初始化常量 RDoc::RDoc”错误 rake -T (in Main) rake aborted! uninitialized constant RDoc
我只是在安装 Ruby Enterprise，无法更改 Ruby Enterprise 安装程序调用的这个崩溃命令的输出目录。 那么我该如何删除目录来满足这个异常: 生成 RDoc 文档./minir
我刚读过 http://www.ruby-lang.org/en/news/2013/02/06/rdoc-xss-cve-2013-0256/ ，关于 RDoc 中 XSS 攻击的报告。 我使用的是
似乎这个问题的最后一篇文章因某种原因被关闭，所以我会试试运气...... 我正在尝试运行一个简单的“rake db:migrate”命令。当我这样做时，我收到标题中的错误。是的，解决方案“看起来”很明
我将 Rdoc 2.58 与 Ruby 1.9.2p138 结合使用。当我使用 Darkfish 格式(这是唯一的选择)生成我的 rdoc 文件时，我没有得到源代码预览。没有错误消息，并且正在为所有类
我现在正在记录一些 ruby 代码。我们有两个类都有一个名为“host”的方法。 在其中一个类中，该方法需要一些特殊注释。在另一个类中，我想引用第一个类，并将该引用作为指向它的链接。 通常在 rd
我正在使用 Doxygen 为 C++ 项目创建内部文档。我让 Doxygen 包含方法等的来源，但这使得页面难以扫描。我希望它表现得像 rdoc 并将源隐藏在默认情况下折叠的块中。 我以为HTML_
有没有办法在不将它们分解为单独的声明的情况下记录以下每个属性？ attr_accessor :a, :b, :c 相对于: # description for a attr_accessor :a #
是否有可能让 rdoc 也显示常量的值，而不仅仅是它的注释？目前正在发电 Constants DEFAULT_CONFIG_FILE Default configuration file lo
我有一个文件 module Adapter ## # :method: avatar ## # :method: avatar=(value) end 在另一个文件中，我想链接到这些方
新手正在尝试找出将页面添加到我的 RDoc 文档的简单任务。如果我执行 rake doc:app 并查看页面，则会有一个边栏显示“Pages”，其中列出了 README_FOR_APP。我想要做的就是
我有一个使用多级继承的 Ruby 编写的程序。所有的父类都实现了子类的对象将使用的方法，但是当我为我的程序生成 rdoc 时，子类的 rdoc 页面只显示该特定类的方法而没有父类的方法. 有谁知道如何
我正在尝试记录我在类里面使用 RDoc 注释编写的一些 rake 任务，但在表示方括号时遇到了麻烦。我想添加一些示例，说明如何使用参数运行我的 rake 任务，因此有一个像这样的 rdoc 行: #
根据 this post , RDoc::usage 目前在 ruby 1.9 中不可用。有没有好的替代品？ 我很想知道标准安装以及 gems 中的可用内容。 最佳答案 我喜欢OptionPars
我想链接到 RDoc 中文件的文档。但我唯一能做的就是使用以下标记: configuration.rb[link:files/configuration_rb.html] 我想以更好的方式来做，像这样
当我跑 rake db:create 我收到此错误 rake aborted! no such file to load -- rdoc/task (See full trace by running
我正在使用 Rake 为我的元素生成 RDoc 文档，但我真的很讨厌 Darkfish 似乎生成的灰色样式。我对其他一切都很满意，我只是想让配色方案更具可读性。 这是我的抽佣任务: Rake::RDo
假设我有以下类(class)。 class Foo # I want the following to appear as-is in my documentation, not as an an
在 Ioke doc 中，ISpec 测试包含在文档中，参见 ioke.org/dok/index.html 这如何用 Ruby 的 RSpec 和 RDoc(或 SDoc)来完成？我找不到任何命令行
我是一名优秀的程序员,十分优秀！