源碼級注釋 · 雜談

[TOC] > ## 注釋處理器: - 解析注釋生成AST(抽象語法樹) - 根據AST進行編譯、索引、信息提取或分析處理 - 不直接生成源碼,注釋只用于元信息或文檔 - 例如Javadoc可以生成文檔,CheckStyle可以進行靜態分析 > ## 語言模型API: - 解析注釋生成AST - 根據AST生成目標源碼 - 可以編譯和執行生成的源碼 - 注釋驅動了源碼的生成,注釋變成了一種語言 - 例如使用JavaCC可以定義SQL注釋,并根據注釋生成SQL語句二者的主要差異在于**是否最終生成并可執行源碼**。注釋處理器更注重利用注釋進行其他處理(文檔、分析等),而不直接生成源碼。**語言模型API則將注釋視為一種語言**,并根據注釋生成可執行的源碼,這是一種源碼生成方式。 > ## 注釋處理器實現步驟: 1. 定義注釋結構和語法 2. 解析注釋生成AST 3. 編譯AST生成文檔 4. 構建索引 5. 信息提取 6. 分析處理 > ## 語言模型API實現步驟: 1. 定義注釋結構和語法(對應語言語義) 2. 解析注釋生成AST 3. 根據AST生成目標源碼 4. 源碼重構(可選) 5. 源碼編譯(可選,如果執行) 6. 執行源碼(可選) > ## 代碼示例: ### 1. 注釋處理器(生成文檔): ``` java /** * @author John * @version 1.0 */ public class Hello { // ... } ``` ### 2. 語言模型API(生成SQL): ``` sql /** * @select * from table */ ``` 解析注釋: ``` java /** * @author John * @version 1.0 */ Comment -> AuthorTag -> "John" -> VersionTag -> "1.0" ``` sql ``` /** * @select * from table */ Select -> "*" From -> "table" ``` ### 3. 注釋處理器(生成文檔): ``` html @author John @version 1.0 ``` ### 4. 語言模型API(生成SQL): ``` sql select * from table ``` > 總結: 注釋處理器和語言模型API都可以解析注釋并進行處理,但最終產出不同: - 注釋處理器:文檔、索引、信息、分析等 - 語言模型API:可執行的源碼 > 注釋處理器更側重于注釋本身及其信息,語言模型API則將注釋視為實現新語言的一種方式。兩者為我們提供了利用注釋進行各種處理的靈活手段。 > 理解注釋處理器和語言模型API的區別和應用場景,可以更好地**設計注釋結構及其處理流程**,實現定制的需求與效果。