1.3 java程序基本说明以及要求

沉吟阿伍

已于 2022-10-05 18:44:32 修改

阅读量109

点赞数

文章标签： java jvm servlet

于 2022-09-25 17:30:17 首次发布

本文链接：https://blog.csdn.net/qq_47360019/article/details/127039874

版权

注释使用规范

Java 注释
为什么要有注释呢？
假设一个程序员新进入一个项目组，接手一个已离职程序员未完成的软件模块功能，当他打开原程序员编写的代码时，其中一个方法（或函数）有上百行代码但没有任何注释，这样造成的结果是，新程序员要花费很长的时间去理解原程序员的业务逻辑和思路，可能还会出现理解错误的情况。怎么解决这个问题呢？就是给程序添加必要的注释。

什么是注释？
Java 程序中的注释是方便程序阅读而写的一些说明性的文字，这些文字不会被视为代码来编译和执行。通过注释提高 Java 源代码的可读性，使得 Java 程序条理清晰，易于理解。

Java 的注释有三种：单行注释、多行注释、文档注释。

//注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行，并写入 javadoc 文档

下面介绍 Java 程序员编写注释的规范。

注释要简单明了，例如：

String engName = “颜群”; //工程师用户名
copy
边写代码边注释，在修改代码的同时修改相应的注释，以保证注释与代码的一致性。有时会出现修改了代码，但没有修改注释的情况，尤其是在使用 javadoc 产生 Java 文档时，已经修改了程序，但没修改文档注释，产生的 Java 文档还是原注释内容，引起错误。

保持注释与其对应的代码相邻，即注释的就近原则，通常放在该段代码的上方或者放在该行代码的右边（单行注释）。

**在必要的地方注释，注释量要适中。**在实际的代码规范中，建议代码注释占程序代码的比例达到 20% 左右。

全局变量要有较详细的注释，包括对其功能、取值范围、用哪些方法存取它以及存取时的注意事项等说明。

源文件头部要有必要的注释信息，包括文件名，版本号，作者，生成日期，模块功能描述（如具体功能、主要算法、内部各部分之间的关系、该文件与其他文件的关系等），主要方法清单及本文件历史修改记录等。以下是源文件头部注释示例：

/**
* Copy Right Information           : lan-qiao
* Project                          : blue-bridge
* JDK version used                 : jdk1.8.101
* Author                           : YQ
* Version                          : 2.1.0,2020/5/20
*/

方法的前面要有必要的注释信息，包括方法名称，功能描述，输入、输出及返回值说明，抛出异常等。以下是方法注释示例。

/**
* Description :对方法进行描述
* @param Hashtable 参数描述1
* @param OrderBean 参数描述2
* @return String 返回值描述
* @exception IndexOutOfBoundsException 对方法可能抛出的异常进行描述
*/
public String checkout(HashTable cart,OrderBean orderBean) throws IndexOutOfBoundsException{
    // 省略具体内容
}

文档注释标签语法。

@author，位置：类，标明开发该类模块的作者
@version，位置：类，标明该类的版本。
@see，位置：类、属性、方法，说明相关主题。
@param，位置：方法，对方法中某参数的说明。
@return，位置：方法，对方法返回值的说明。
@exception，位置：方法，对方法可能抛出的异常进行说明。
如下程序是为 HelloWorld 增加注释后的完整程序：

/**
* Copy Right Information            : lan-qiao
* Project                          : blue-bridge
* JDK version used                 : jdk1.8.101
* Author                           : YQ
* Version                          : 2.1.0, 2020/5/1
*/
public class HelloWorld{
/**
* Description: 主函数，程序入口
* @param String[] args
* @return void
*/
public static void main(String[] args){
    System.out.println("HelloWorld!");    //输出HelloWorld!到控制台
    }
}

有哪些集成开发环境

集成开发环境（IDE，Integrated Development Environment ）是用于提供程序开发环境的应用程序，它通常集成了代码编写、错误分析与提示、编译、运行、调试等功能，不像记事本只提供了代码编写功能。以下是常见的 Java 集成开发环境。

Eclipse：Eclipse 是一个开放源代码的、基于 Java 的可扩展开发平台。就其本身而言，它只是一个框架和一组服务，通过插件组件构建开发环境。
2. MyEclipse：MyEclipse 是一个十分优秀的用于开发 Java SE、Java EE 的 Eclipse 插件集合，功能非常强大，支持也十分广泛，尤其是对各种开源产品的支持非常不错。
3. IntelliJ IDEA：IntelliJ IDEA（简称 IDEA）是 JetBrains 出品的 Java 集成开发环境，在近几年的发展尤为迅速，目前使用也非常广泛。IDEA 提倡智能编码，意图利用开发工具减少程序员的工作量，拥有智能提示、重构、编码辅助等丰富的功能。