代码编写规范
ModifiedbyJACKo
theafter
oo
ofDecember262020
f知识管理系统代码编写规范一、介绍本文档为《知识管理系统》代码编写规范,为保证代码风格的一致性和后期的可维护性,文档讲述的内容要求所有开发人员必须遵守。本规范主要参考了GoogleJavaStyle,包括了其他一些业界约定俗成的公约和普遍采用的标准。本规范并非最终标准,一些规定还需再做商讨。
术语说明本文档除非特殊说明,否则:1类(class)统指普通类、枚举类、接口和注解类型。2注释(comme
t)只用来指实现注释(impleme
tatio
comme
ts)。我们不
使用“文档注释”这样的说法,而会直接说Javadoc。其他“术语说明”,将在文档中需要说明的地方单独说明。
文档说明本文档中的代码并不一定符合所有规范。即使这些代码遵循本规范,但这不是唯一的代码方式。例子中可选的格式风格也不应该作为强制执行的规范。二、源码文件基础
文件名
f源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为java。文件编码:UTF8
源码文件使用UTF8编码。特殊字符空格字符
除了换行符外,ASCII水平空白字符(0x20)是源码文件中唯一支持的空格字符。这意味着:1其他空白字符将被转义。2Tab字符不被用作缩进控制。
特殊转义字符串任何需要转义字符串表示的字符(例如bt
fr