java命名规则-注释

java的命名规则在写java程序的时候十分重要，不仅仅是为了代码的规范。大型的工程中代码重构是十分有必要的，这其中规范的命名规则有助于程序员快速的了解代码。解决代码冗余、繁杂的问题。

注意：在所有的命名规则中忌用汉语拼音，一定要使用英文，做到见明知意。

一、命名规范

1.命名规则–遵循标识符命名规则
1）标识符由字母，数字，下划线，以及$（美元符号）组成

注：这是与c语言不同的地方，c语言中没有$

2）以字母，下划线，或者$（美元符号）开头。
3）不可以与关键字重名。
4）区分大小写。
2.项目名–javaproject
项目名称全部用小写
3.包名
包名全部用小写，用“.”来隔开，一般以公司域名来作为包名。

例如：com.csdn.standard com-表示域名
csdn-表示这个包的所有权（属于个人的话就写个人名称，属于团队写团队名称，属于公司写公司的名称）
standard-表示这个包的功能

这样写的包的名称是为了能工号的了解包的所有权和它的功能。
3.类名
类名所有的单词的首字母要大写，遵循大驼峰式的命名规则

例如MyClass

4.属性名
与属性命名规则相同

String userName

5.方法名
与属性的命名规范相同

例如： public void writeBlog(){}

6.常量名
常量的所有字母大写,其中多个单词之间要用下划线分割

例如：int MAX_VALUE;

二、java的注释分为五种：

1.单行注释

//注释内容

2.多行注释

/*
注释内容
*/

3.文档注释

/*

• 注释内容
  */

4.函数注释（重点）
方法一：先敲“/”再敲两个**，然后回车
方法二：alt+shift+J

/**
/* 登录验证
/* @param 传入的 /* @return
/* @throws Exception
*/

5.注释的快捷键
添加 注释 Ctrl+Shift+/,
去除注释的快捷键是Ctrl+Shift+\

//hhah
//sjsj

三、总结分为三点：

1，弄清楚需求
弄清楚具体的工作。
2，设计思路
思路可以通过用文档的形式写下来，或者画流程图。
3，写代码
写代码之前首先写注释，每个功能模块的功能。然后再逐渐向程序里添加模块
这样保证思路清晰，能够很快的写完代码。