JAVA编程规范_4.如何标注未添加注释的类

最新推荐文章于 2024-10-17 10:27:13 发布

jrscript

最新推荐文章于 2024-10-17 10:27:13 发布

阅读量169

点赞数

分类专栏： Java代码质量管理 java编程规范文章标签： java

本文链接：https://blog.csdn.net/jrscript/article/details/116209047

版权

Java代码质量管理同时被 2 个专栏收录

10 篇文章 0 订阅

订阅专栏

java编程规范

10 篇文章 0 订阅

订阅专栏

本文介绍如何利用jrscript脚本自动化为Java代码的类、接口、枚举和注解添加注释。脚本通过hookstk参数指定需要检查的结构，并通过getUCommons获取头部注释，然后插入新注释。此方法有助于提高代码的可读性和维护性。

摘要由CSDN通过智能技术生成

如何标注未添加注释的类

正常情况下，代码中的类、接口、枚举、注解等等，均需要在头部添加注释说明。如果没有注释，jrscript脚本可以对各种结构的头部添加标注。

脚本实现如下（语法规范参考jrscript.cn）:

#include "java.h"
string checkCLSCommons()hooks tk : @"CLS",@"ITF",@"ENUM",@"ANT" {

	token [] tkList=getUCommons(tk);
	if(tkList.length>0) return null;
	
	string content = "// should common the class there by jrscript.cn";
 	log(content);
	symbol [] symList = toSymbolList(content);
	char [] styp = {'L'};
	token ctk = createUnitToken(COMMONS, symList, styp);
	insertToken(tk, ctk, 1, false);
	return "should common the class there";
}

#include "java.h”表示hooks函数支持的编程语言。
hooks 方法定义 checkCLSCommons()hooks tk : @“CLS”,@“ITF”,@“ENUM”,@“ANT” 表示该脚本将对检测的所有代码文件中，“CLS” 单词，也就是类进行检测。getUCommons方法是获得单词头部注释列表， log（）是执行过程中打印日志。toSymbolList（）是将字符串转换成符号列表。createUnitToken是创建一个单词。insertToken将单词添加到检测的单词头部。