0

0

Java中的单行注释和多行注释

yulia

yulia

发布时间:2018-09-15 17:57:06

|

8857人浏览过

|

来源于php中文网

原创

在编程中,注释是必不可少的一部分,注释一方面可以看清代码的结构,找起来更方便,另一方面,也有利于同事之间的工作交接。那么今天就和大家聊聊java中的单行注释和多行注释吧,有需要的朋友可以参考一下,希望对你有所帮助。

什么是注释?注释就是一段文字,这段文字并不是必须的,也不直接参与代码运行。

注释用来说明某段代码的作用,或者说明某个类的用途,每个方法的功能,以及该方法的参数和返回值的数据类型及意义等。

为什么要添加注释?

1,永远不要过于相信自己的理解力。为了过段时间还能简单明了的看懂自己的以前的代码,建议添加注释。
2,可读性第一,效率第二。团队协同开发中,团队成员的沟通比较重要,为了自己写的代码能被整个团队理解,建议添加注释。
3,代码即文档。自己平时写一些代码,为了生成一些规范的文档,建议添加注释。

立即学习Java免费学习笔记(深入)”;

实际工作中,经常会听到一些同事说别人的代码没注释怎么怎么样,实际上写的漂亮的代码不需要太多的注释,相反的,我个人对于满屏幕的注释或者是一些无用的代码极其反感,特别是使用git,svn等工具做版本管理之后,我都会把那些无用的注释掉的代码全部删掉。

这里整理一下我对注释的个人理解:

1,必要的注释还是必须要有的,比如说Javabean中的字段意义,就应该有相关的注释。比如说一些编码中暂时实现功能,但是存在一些不好的待优化的地方,我一般会写一个TODO,实现基本功能后续我自己再回过头来完善。
2,不要写一些白痴的无用注释,不要保留任何一行被注释掉的代码,现在代码一般都有版本工具做管理,所以根本不用担心代码会丢掉。
3,严格的遵守Java的命名规范,不用担心变量名称太长,不用担心方法名称太长,合理的一个英语的翻译命名比写那些无用的汉语注释强多啦。

程序注释是源代码的一个重要部分,对于一份规范的程序源代码来说,注释应该占到源代码的三分之一左右。

几乎所有的编程语言都提供了注释的功能,一般的编程语言都提供了基本的单行注释和多行注释,Java也不例外。除此之外,Java语言还提供了一种文档注释。

mallcloud商城
mallcloud商城

mallcloud商城基于SpringBoot2.x、SpringCloud和SpringCloudAlibaba并采用前后端分离vue的企业级微服务敏捷开发系统架构。并引入组件化的思想实现高内聚低耦合,项目代码简洁注释丰富上手容易,适合学习和企业中使用。真正实现了基于RBAC、jwt和oauth2的无状态统一权限认证的解决方案,面向互联网设计同时适合B端和C端用户,支持CI/CD多环境部署,并提

下载

这篇博客先整理一下Java中的单行注释和多行注释,文档注释一般用来生成API。

单行注释和多行注释

单行注释就是在程序中注释一行代码,在Java语言中,将双斜线"//"放在需要注释的内容之前就可以啦。

在eclipse中,单行注释的快捷键是command+/,按一次是添加注释,在按一次就是取消注释。

多行注释就是一次性的将程序中的多行代码注释掉,在Java语言中,使用"/*"和"*/"将程序中需要注释的内容包含起来,"/*"表示注释开始,"*/"表示注释结束。

在eclipse中,多行注释的快捷键是command+control+/,使用的时候要选中代码,我一般很少用多行注释。

现在贴出一段代码,来演示一下Java中的单行注释和多行注释。

/**
 * Java的单行注释和多行注释.
 * 
 * @author LinkinPark
 */
public class Comment
{
 public static void main(String[] args)
 {
  // 这里是Java的单行注释
  System.out.println("演示Java的单行注释。。。");
  /*
   * 这里是Java的多行注释
   */
  System.out.println("演示Java的多行注释。。。");
 }
}

相关文章

java速学教程(入门到精通)
java速学教程(入门到精通)

java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

830

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

735

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

733

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

396

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

24

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.4万人学习

C# 教程
C# 教程

共94课时 | 6.4万人学习

Java 教程
Java 教程

共578课时 | 44.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号