Java网络程序设计 课件 单元1-04Java 注释_第1页
Java网络程序设计 课件 单元1-04Java 注释_第2页
Java网络程序设计 课件 单元1-04Java 注释_第3页
Java网络程序设计 课件 单元1-04Java 注释_第4页
Java网络程序设计 课件 单元1-04Java 注释_第5页
已阅读5页，还剩2页未读， 继续免费阅读

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

初识Java单元一Java概述Java程序运行机制Java程序开发Java注释目录CONTENTS12341.4Java注释1、为什么要有注释?

假设一个程序员新进入一个项目组，接手一个已离职程序员未完成的软件模块功能，当他打开原程序员编写的代码时，其中一个方法可能有上百行代码，没有任何注释。这样造成的结果是，新程序员要花费很长的时间去理解原程序员的业务逻辑和思路，可能还会出现理解错误的情况。怎么解决这个问题呢？在一个规范化的软件开发项目组里，程序的编写是必须要有注释的，Java程序编写也不例外1.4Java注释2．什么是注释?

Java程序中的注释就是方便程序阅读而写的一些说明性的文字。通过注释提高Java源程序代码的可读性，使得Java程序条理清晰，易于理解。Java的注释有3种：单行注释、多行注释、文档注释。

//

注释一行

/*......*/注释若干行/**......*/注释若干行，并写入javadoc文档1.4Java注释3、编写注释的规范

（1）注释要简单明了（2）边写代码边注释，修改代码的同时修改相应的注释，以保证注释与代码的一致性（3）保持注释与其对应的代码相邻，即注释的就近原则，通常是放在该段代码的上方或者放在该行代码的右边（单行注释） .（4）注释量要适中。在实际的代码规范中，要求注释占程序代码的比例达到20%左右（5）全局变量要有较详细的注释，包括功能、取值范围、方法存取时的注意事项等说明（6）源文件头部要有必要的注释信息，包括文件名，版本号，作者，生成日期，模块功能描述，主要方法清单及本文件历史修改记录等（7）方法前面要有必要的注释信息，包括方法名称，功能描述，输入、输出及返回值说明，抛出异常等1.4Java注释下面是第一个Java程序增加注释后的完整程序。/***CopyRightInformation :blue-dot*Project :blue-bridge*JDKversionused :jdk1.8.0*Author :JackYang*Version :2.1.0,2021/11/1**/publicclassHelloWorld{/***Description:主函数，程序入口*@paramString[]args*@returnvoid*/publicstaticvoidmain(String[]args){System.out.pri

人人文库> 全部分类> 教育资料 > 备课教案

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论