代码注释与编码规范

  1.代码注释

  (1)单行注释:  "//"

  (2)多行注释:  "/*  */"

  (3)文档注释:  "/**  */"       会被Javadoc文档工具读取作为Javadoc文档内容。

  2.编码规范

  (1)每条语句独占一行,一条命令要以分号结束。

  (2)在声明变量时,尽量使每个变量的声明单独占一行,即使是相同得数据类型也要将其放置在单独的一行,有利于添加注释。

      对于局部变量应在声明的同时对其进行初始化。

  (3)在Java代码中,关键字与关键字间如果有多个空格,均被视为一个。

  (4)不要使用技术性很高、难懂、易混淆判断的语句。

  (5)对于关键的方法要多加注释,有助于读者了解代码结构。

你可能感兴趣的:(编码规范)