Lua Annotate
 |
||
|
Lua Annotate |
|
LuaAnnotate 是一个工具，用于将 C 源文件的注释内联显示到源代码中，但存储在一个单独的文件中。注释保存在 C 源文件所在目录中的一个文本文件（[annotate.txt]）中。以多种方式可以实现将注释内联显示到 C 代码中：
该项目的最初动机是允许 Lua 用户更好地记录 Lua 源代码。Lua 源代码密度很大但注释稀疏。尚不确定原始 Lua 作者是否会在上游源代码中大量使用注释，因此我们需要单独维护这些注释。当上游源代码发生变化，并且用户可能维护自己的补丁集时，这会变得具有挑战性。在此处使用统一补丁的问题在于，其中包含的上下文信息比必需的更详细，并且其冲突检查比必需的更严格。所有注释数据实际上只需要说明某个标识符对应某个文档，几乎是以 ctags 的方式。此外，如果无法在源代码中匹配到这样的标识符，我们也不会太在意——这仅仅是文档。
示例（查看 lobject.h）
有关更多详细信息和下载，请参阅 [lua-annotate on github]。