查看完整版本: A.2 Ruby程序的注释

A.2 Ruby程序的注释

Ruby程序的注释有两种形式：

１、单行注释
２、多行注释

[u]单行注释[/u]也是Ruby代码的文档注释，因为你可以用rdoc命令行工具生成Ruby类的rdoc文档。[code]rdoc a.rb[/code]运行后在当前目录有一个doc文件夹，打开这个文件夹，打开index.html文件，你就会看见
rdoc生成的文档注释。

[u]多行注释[/u]由： 包括在　=begin 和 =end　之间的内容组成，你唯一需要注意的是： =begin 和　=end
必须顶格写。放在　=begin 和　=end 之间的内容会被Ruby忽略。

我做了实验，同时有单行注释和多行注释，确实是：单行注释也是Ruby代码的文档注释，可以在网页上看到。
但多行注释也确实被Ruby忽略了，就是在网页上没有和单行注释一起显示出来。
我以前没有注意到这些细节。

今天弄到这些细节，干脆都弄明白吧。直接问讲师吧。

问题一：有时需要将多行注释的内容像单行注释一样输出的话，怎么做呢（除了用单行连续注释以外）？

问题二：单行注释被显示在.html网页中，如果需要输出到某个指定的文件，可以吗？能给个例子吗？

回复 2# 的帖子

可以考虑：Here Document语法，比如：

puts <<OK
    1、第一行
  2、第二行
OK

＃Here Document语法：
＃<<标识符
＃标识符
＃
＃Here Document的使用很讲究技巧，比如： """ ok """ 等的使用。
＃不知这可以解决你的问题吗？

[[i] 本帖最后由 quzhongwei 于 2008-6-11 00:03 编辑 [/i]]

这样吧，你告诉我在哪本相关的书中有介绍，我去查来看看。
可以吗？

为啥提出这些问题？我在考虑如何提高写详细设计文档的效率。
面向对象的详细设计有时可以和编程同时进行的，如果注释能帮助工程师高效完成一些设计的内容，就好了。
比如，Java的注释和Doc功能，如果会利用，就可以帮助工程师高效完成大部分设计的内容。文档是软件工程很重要的部分呀。

回复 4# 的帖子

看看这个能否满足伱的要求吗？

《The Ruby Way》

到后面的叙述，我会提到这个问题！

[[i] 本帖最后由 quzhongwei 于 2008-6-11 00:32 编辑 [/i]]

OK，我抽时间去看看。谢谢！:handshake

Here Document语法，标识符需要大写，楼主没讲到。。。
班门弄斧，小弟就知道这个。:lol

[quote]原帖由 [i]枫灯[/i] 于 2008-6-11 19:15 发表 [url=http://www.ruby-lang.org.cn/forums/redirect.php?goto=findpost&pid=16662&ptid=5096][img]http://www.ruby-lang.org.cn/forums/images/common/back.gif[/img][/url]
Here Document语法，标识符需要大写，楼主没讲到。。。
班门弄斧，小弟就知道这个。:lol [/quote]

讲师说了以后会讲到，他只是在回答我的问题，建议我用Here Document来解决我的问题。
我会抽空去看的。

谢谢大家。

[quote]原帖由 [i]枫灯[/i] 于 2008-6-11 19:15 发表 [url=http://www.ruby-lang.org.cn/forums/redirect.php?goto=findpost&pid=16662&ptid=5096][img]http://www.ruby-lang.org.cn/forums/images/common/back.gif[/img][/url]
Here Document语法，标识符需要大写，楼主没讲到。。。
班门弄斧，小弟就知道这个。:lol [/quote]


还没有正式讲到这个语法点

:( 我要一步一步往上爬.......:(

[quote]原帖由 [i]gongmeihao[/i] 于 2008-6-13 17:27 发表 [url=http://www.ruby-lang.org.cn/forums/redirect.php?goto=findpost&pid=16782&ptid=5096][img]http://www.ruby-lang.org.cn/forums/images/common/back.gif[/img][/url]
:( 我要一步一步往上爬.......:( [/quote]

像小蜗牛了，一步一步地爬，但不怕，有目标呢。

:) :) 看了

额。。。。注释具体来说在这里怎么体现出来他的作用呢？？？？我不明白～～:'(

[quote]原帖由 [i]dhb008[/i] 于 2008-7-14 16:17 发表 [url=http://www.ruby-lang.org.cn/forums/redirect.php?goto=findpost&pid=18007&ptid=5096][img]http://www.ruby-lang.org.cn/forums/images/common/back.gif[/img][/url]
额。。。。注释具体来说在这里怎么体现出来他的作用呢？？？？我不明白～～:'( [/quote]

再看看书，就明白了。

Here Document标志谁说第一字母要大写的啊？小写也一样可以

[quote]原帖由 [i]drive2me[/i] 于 2008-6-10 23:30 发表 [url=http://www.ruby-lang.org.cn/forums/redirect.php?goto=findpost&pid=16614&ptid=5096][img]http://www.ruby-lang.org.cn/forums/images/common/back.gif[/img][/url]
我做了实验，同时有单行注释和多行注释，确实是：单行注释也是Ruby代码的文档注释，可以在网页上看到。
但多行注释也确实被Ruby忽略了，就是在网页上没有和单行注释一起显示出来。
我以前没有注意到这些细节。

... [/quote]
第一个问题,可以这样写[code]#!/usr/bin/ruby
  2 =begin rdoc
  3 puts "hello,Ruby"
  4 def foo
  5  puts "hello,world"
  6 end
  7 =end
  8 class A
  9   puts "A"
10   def WoW
11     puts "WoW"
12   end
13 end[/code]然后用rdoc就可以了.
ps：多次单行注释也没有什么不好的,使用vim的话相当方便  1,100 s/^/#/g  这个vim命令是1到100行前面加#注释.

第二个问题

如果你想把程序中的注释统统提取出来放到一个文件里,shell很容易做到哦

cat OOXX.rb | grep '^#' | grep -v '^$' >> OOXX.txt

第一个grep是取出所有#开头的行,第二个grep是排除所有的空格.

正在爬行中。。。。