还剩19页未读,继续阅读
本资源只提供10页预览,全部文档请下载后查看!喜欢就下载吧,查找使用更方便
文本内容:
知识管理系统代码编写规范
一、介绍本文档为《知识管理系统》代码编写规范,为保证代码风格的一致性和后期的可维护性,文档讲述的内容要求所有开发人员必须遵守本规范主要参考了GoogleJavaStyle,包括了其他一些业界约定俗成的公约和普遍采用的标准本规范并非最终标准,一些规定还需再做商讨
1.1术语说明本文档除非特殊说明,否则类(class)统指普通类、枚举类、接口和注解类型注释(comment)只用来指实现注释(implementationcomments)我们不使用“文档注释”这样的说法,而会直接说Javadoc其他“术语说明”,将在文档中需要说明的地方单独说明
1.2文档说明本文档中的代码并不一定符合所有规范即使这些代码遵循本规范,但这不是唯一的代码方式例子中可选的格式风格也不应该作为强制执行的规范
二、源码文件基础
2.1文件名源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java
2.2文件编码UTF-8源码文件使用UTF-8编码
2.3特殊字符
2.
3.1空格字符除了换行符外,ASCII水平空白字符(0x20)是源码文件中唯一支持的空格字符这意味着其他空白字符将被转义Tab字符不被用作缩进控制
2.
3.2特殊转义字符串任何需要转义字符串表示的字符(例如\b \t \n \f \r \ \和\\等),采用这种转义字符串的方式表示,而不采用对应字符的八进制数(例如 \012)或Unicode码(例如 \u000a)表示
2.
3.3非ASCII字符对于其余非ASCII字符,直接使用Unicode字符(例如 ∞),或者对应的Unicode码(例如 \u221e)转义都是允许的唯一需要考虑的是,何种方式更能使代码容易阅读和理解注意在使用Unicode码转义,或者甚至是有时直接使用Unicode字符的时候,添加一点说明注释将对别人读懂代码很有帮助
三、源码文件结构源码文件按照先后顺序,由以下几部分组成license或者copyright声明信息(如果需要声明)包(package)声明语句import语句类声明(每个源码文件只能有一个顶级类)每个部分之间应该只有一行空行作为间隔
3.1license或者...。