Java介绍及编程规范.pptVIP

* * * * * * * * * * 不要用空格键缩进了 用Tab键自动缩进4个格 Eclipse: 导入格式文件 ctrl+shift+f 格式化 * * * * * * * * * * * * * * * * 类属性/方法/成员变量 以业务注释代替技术注释 建议先写注释 再写代码 * * 类属性/方法/成员变量 以业务注释代替技术注释 建议先写注释 再写代码 * * 类属性/方法/成员变量 以业务注释代替技术注释 建议先写注释 再写代码 * * * * * * * * 动词+宾语 * * Is Has Exists 见名知意 * * 名字如果用 I j k 在循环时 可以用 其他情况不用 从名字能看出它的业务含义和字段类型，如集合类型把类型作为后缀 xxxMap xxxList xxxArray xxxSet * * * * 名字如果用 I j k 在循环时 可以用 其他情况不用 从名字能看出它的业务含义和字段类型，如集合类型把类型作为后缀 xxxMap xxxList xxxArray xxxSet * * * * 数据库操作的代码、文件操作的代码 * * 数据库操作的代码、文件操作的代码 * * 数据库操作的代码、文件操作的代码 * * * * 魔鬼数字 * * 最后再拿出doc来讲解几个，然后留下讨论的时间 * * 三、编程规范 注释规范 类和接口的注释：放在 package 关键字之后，class 或者 interface 关键字之前。 类和接口的注释内容：主要是一句话功能简述、功能详细描述 /** * 〈一句话功能简述〉 * 〈功能详细描述〉 * @author [作者] * @version [版本号, YYYY-MM-DD] * @see [相关类/方法] * @since [产品/模块版本] * @deprecated */ public class CommManager  三、编程规范 注释规范 成员变量的注释：写在成员变量上面。 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。 /** * 注释内容 */ private String logType; /** * 注释内容 */ public static final double MAX_VALUE = 1.79769313486231570e+308;  三、编程规范 注释规范 公有和保护方法注释：写在公有和保护方法上面。 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等 /** * 〈一句话功能简述〉 * 〈功能详细描述〉 * @param [参数1] [参数1说明] * @param [参数2] [参数2说明] * @return [返回类型说明] * @exception/throws [违例类型] [违例说明] * @see [类、类#方法、类#成员] * @deprecated */ public void write()  三、编程规范 注释规范 Javadoc注释标识列表  标记 使用范围 说明 @author name 类、接口 指明该代码的作者 @deprecated 类、接口、方法 指明对于这个API中的类、接口是方法，成员变量已经过时 @exception name 描述 方法 描述成员方法运行时可能抛出的异常， @param name 描述 方法 描述成员方法的参数 @return 描述 方法 方法有返回值，用此标记描述返回值的类型，以及返回值的描述 详细列表参见《java编程规范》2.1.16节 三、编程规范 注释规范 注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 //注释 program code one //注释 program code two  三、编程规范 命名规范 包名采用域后缀倒置的加上自定义的包名，采用小写字母。在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。 格式： package com.