LuaDoc自動生成注釋工具使用說明文件

2021-08-16 00:12:15 字數 1521 閱讀 6086

這個lua工具可能很多人都裝了,測試方法,cmd開啟後輸入lua回車,產生如下介面即已經安裝

1.1 將lua的安裝目錄配置到path環境變數中。

如lua預設安裝,目錄為c:\program files(x86)\lua\bin;

windows選單中右鍵計算機-》屬性-》高階系統設定-》高階-》環境變數-》path裡面最後新增 c:\program files (x86)\lua \bin; (切記與前一項用分號隔開)

最後啟動cmd,直接打lua回車,出現上圖就說明lua環境安裝成功。

2、使用luadoc

在cmd中輸入: 

luadoc     –d      指定文件輸出路徑       需要生產的檔案

如生成整個資料夾的文件到桌面的test資料夾中,在cmd中輸入

luadoc      –d     c:\users\caomx\desktop\test    *

即可。生產的資料夾中執行index.html就可以看到生成的luadoc文件網頁。

3、lua中的注釋規範

--- 

測試用表

-- @class table

-- @name testtable

-- @field testa 

測試字段

a-- @field testb 

測試字段

btesttable =

--- 

測試函式

-- @param a 引數a

-- @param b 引數b

-- @return 返回1

上圖為舉例**生成的文件格式,具體注釋視實際情況而定。

3.1 乙個函式或者**的前面使用 --- +說明文字注釋

3.2 **使用@class table + @name 表名 開頭,@field 欄位名 字段說明 來表示內部成員變數。

3.3 函式使用@function 函式名開頭,@param 表示引數,@return表示返回值,@usage表示使用方法,這些引數按實際需求寫注釋。

@see 表示鏈結跳轉,表示理解此函式還需要看的其他地方

專案中想整理一下lua編碼注釋問題,形成文件便於新人理解和查閱。於是研究了下luadoc,自行整理了上面這篇博文,填坑乙個。

自動生成注釋

在團隊開發中,注釋是必不可少的,方便以後維護 由於大家都寫注釋,所以對注釋的格式應該統一。我們可以使用eclipse注釋模板自動生成注釋。勾選最下面的 automatically add comments for new methods and types 1,給類新增注釋模板 點選types然後e...

自動生成頭注釋檔案

進行有關程式方面工作的都知道,一段簡潔易懂質量高的 離不開注釋的強有力輔助,在團隊合作開發中注釋更是發揮著舉足輕重的作用。但是我們常常對那些重複性的諸如頭部注釋這樣的注釋感到疲憊不堪。下面我們就以頭部注釋為例進行 自動生成重複注釋 諸如頭部注釋 的方法講解。自動生成頭部注釋其實挺簡單的,主要是對系統...

idea 自動生成方法注釋

目錄 實現效果 idea 配置 如圖所示 具體實現 在你要新增注釋的方法上 打出乙個 號,然後按下 tab鍵即可。param userid 使用者id param coupons param status 優惠卷的狀態 description return 儲存成功的個數 author liren ...