打印

A.2 Ruby程序的注释

本帖已经被作者加入个人空间 本主题由 quzhongwei 于 2008-6-10 14:10 设置高亮

A.2 Ruby程序的注释

php?name=Ruby" onclick="tagshow(event)" class="t_tag">Ruby程序的注释有两种形式:

1、单行注释
2、多行注释

单行注释也是Ruby代码的文档注释,因为你可以用rdoc命令行工具生成Ruby类的rdoc文档。


运行后在当前目录有一个doc文件夹,打开这个文件夹,打开index.html文件,你就会看见
rdoc生成的文档注释。

多行注释由: 包括在 =begin 和 =end 之间的内容组成,你唯一需要注意的是: =begin 和 =end
必须顶格写。放在 =begin 和 =end 之间的内容会被Ruby忽略。
本帖最近评分记录
  • drive2me R币 +10 Thanks! 2008-6-10 18:53

TOP

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

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

问题一:有时需要将多行注释的内容像单行注释一样输出的话,怎么做呢(除了用单行连续注释以外)?

问题二:单行注释被显示在.html网页中,如果需要输出到某个指定的文件,可以吗?能给个例子吗?
Flying Piggy...! 
天地人合一!

TOP

回复 2# 的帖子

可以考虑:Here Document语法,比如:

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

#Here Document语法:
#<<标识符
#标识符

#Here Document的使用很讲究技巧,比如: """ ok """ 等的使用。
#不知这可以解决你的问题吗?

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

TOP

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

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

TOP

回复 4# 的帖子

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

《The Ruby Way》

到后面的叙述,我会提到这个问题!

[ 本帖最后由 quzhongwei 于 2008-6-11 00:32 编辑 ]
本帖最近评分记录
  • drive2me 威望 +5 谢谢! 2008-6-11 01:09
  • drive2me R币 +5 谢谢! 2008-6-11 01:09
  • drive2me 贡献 +5 谢谢! 2008-6-11 01:09

TOP

OK,我抽时间去看看。谢谢!
Flying Piggy...! 
天地人合一!

TOP

Here Document语法,标识符需要大写,楼主没讲到。。。
班门弄斧,小弟就知道这个。
本帖最近评分记录
  • quzhongwei R币 +1 谢谢,多提意见 2008-6-11 19:21
  • drive2me R币 +1 谢谢参与。 2008-6-11 19:20

TOP

引用:
原帖由 枫灯 于 2008-6-11 19:15 发表
Here Document语法,标识符需要大写,楼主没讲到。。。
班门弄斧,小弟就知道这个。
讲师说了以后会讲到,他只是在回答我的问题,建议我用Here Document来解决我的问题。
我会抽空去看的。

谢谢大家。
Flying Piggy...! 
天地人合一!

TOP

引用:
原帖由 枫灯 于 2008-6-11 19:15 发表
Here Document语法,标识符需要大写,楼主没讲到。。。
班门弄斧,小弟就知道这个。
还没有正式讲到这个语法点

TOP

我要一步一步往上爬.......
本帖最近评分记录

TOP

引用:
原帖由 gongmeihao 于 2008-6-13 17:27 发表
我要一步一步往上爬.......
像小蜗牛了,一步一步地爬,但不怕,有目标呢。
Flying Piggy...! 
天地人合一!

TOP

看了

TOP

额。。。。注释具体来说在这里怎么体现出来他的作用呢????我不明白~~
我是一只菜~菜~菜~菜鸟~~~~嗷~嗷嗷嗷

TOP

引用:
原帖由 dhb008 于 2008-7-14 16:17 发表
额。。。。注释具体来说在这里怎么体现出来他的作用呢????我不明白~~
再看看书,就明白了。
Flying Piggy...! 
天地人合一!

TOP

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

TOP

2008-11-22 20:13 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html) @38.103.63.61