出自我的Blog http://lightyror.blogspot.com/2006/09/rails-rdoc.html Rdoc 是 Ruby build in 的 doc system 因为做的很好 Rails 就直接采用了 如果你不想记格式 你只需要在你的 Rails 程式里面写注解 打入 rake appdoc 他就会在你的 doc/app/ 目录下面产生 doc system 档案 预设是 HTML 格式，直接看 index.html 就好了 再来，就先介绍一下最重要的技巧 1. 如果你想表示这个class ，就在所有Class的前面加入注解，他就会在那个 Class 页面产生相关的描述档 # 这个class用来来干麻干麻的 class ApplicationController 2. 如果你像对某个 method 做 doc ，就在那个 method 前面加入注解 #这个method用来干麽干麽的 def redirect_to_index_page end 3. 如果你在 ABC Class 里面想表示 DEF Class 里面的 method lala() 要这样写 DEF#lala 这样他就会自动帮你建 hyperlinik 到那边 剩下的技巧我觉得不是特别常用 不过就当尝试一下搂 1. 建立超连结就是 {超连结名字}[超连结url] {abc}[www.google.com] 2. #-- 下面的注解不会建立 rdoc ，但是之後加上 #++ ，後面的注解就会被 rdoc parse #这里记载着所有Global 变数以及Authoize 函式 #1这里记载着所有Global 变数以及Authoize 函式 # #-- #2这不会显示 # #++ # #3这里会显示 3. List 就是加 * 像是 #* 123 #* iujoj #* 789 4. h1 , h2 , h3 就是 = , == , === #= Header one #== Header two #=== Header three 5. 斜体字是用 _ 包起来，粗体是用 * 包起来 _page_ => page *page* => page -- lighty RoR 是一个介绍 lighttpd , SQLite , Ruby and Rails 的 Blog http://lightyror.blogspot.com/ --

※ 发信站: 批踢踢实业坊(ptt.cc) ◆ From: 61.230.111.228