Lua Annotate
 |
||
|
Lua Annotate |
|
LuaAnnotate 是一種工具，可以用於展示 C 原始碼檔案的註解，顯示於原始碼內，但儲存在另一個檔案中。這些註解會以文字檔形式維護（[annotate.txt]），這個檔案會在 C 原始碼所在的目錄中。顯示 C 程式碼中的內嵌註解有多種方式
這個專案最一開始的目的是要讓 Lua 使用者可以更完善地為 Lua 原始碼撰寫文件。Lua 原始碼很密集，但註解卻很少。目前尚不確定原始 Lua 作者是否會在最初的上游原始碼中大量加入註解，所以我們必須自行維護註解。當上游原始碼變更，且使用者可能會維護自己的修補程式組時，就會造成挑戰。統一修補程式在此處所遇到的問題，在於所含的脈絡資訊比必要的還要詳細，而其衝突檢查比必要的還要嚴格。所有的註解資料真正需要陳述的，就是某個識別碼對應到某個文件片段，有點類似於 ctags。此外，如果原始碼中無法比對到此類識別碼，我們也不太在乎，因為這只是文件而已。
範例（檢視 lobject.h）
如需進一步的詳細資料，以及下載資訊，請參閱 [github 上的 lua-annotate]。