出自我的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