写代码的好习惯：注释

已于 2022-01-30 18:38:31 修改
阅读量404 收藏
点赞数
文章标签： java
于 2022-01-30 18:38:09 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/promiseMSummer/article/details/122754841
版权

基础语法

写注释是个非常好的习惯

单行注释

//注释

//双正斜杠后面加单行注释

多行注释

/星号多行注释

多行注释

多行注释

多行注释星号/

此处

文档注释

（JavaDoc）以后会说，先留个印象即可。

promiseMSummer
关注
如何写好代码-注释.pptx
09-09
### 如何写好代码——注释 #### 一、好代码的标准 优秀的代码不仅能够实现功能需求，还应该具备良好的可读性、可维护性和扩展性。为了达到这些标准，除了编写逻辑清晰、结构合理的代码之外，恰当的注释也是不可或...
提高代码可读性的十大注释技巧分享
10-22
10. **注释先行**：有些人主张先写注释，后写代码，因为这可以帮助理清思路。注释可以作为设计思路的蓝图，指导代码的实现。 通过遵循这些注释技巧，开发者可以显著提高代码的可读性，降低维护成本，增强团队间的...
给代码添加注释的时候的一个好习惯
weixin_48853167的博客
03-16 202
给代码添加注释的时候的一个好习惯 1.描述一个代码块的功能或者一个模块的功能时将注释放在这个代码块上部，代码块结束后加空行与其他块分隔一下 2.描述一个块中的某条语句的作用和注意事项时，直接在这个语句的后面加注释就可以了 例： #include <stdio.h> #include <string.h> #include <stdlib.h> #include <unistd.h> #include <arpa/inet.h> #include &
笔记六(良好的代码习惯很重要，添加注释！！，避免中文 ，所有命名避免关键字)
somdip的博客
12-12 332
1.响应代码：200表示成功，3xx表示重定向，4xx表示客户端发送的请求有错误，5xx表示服务器端处理时发生了错误； 2.REST就是一种设计API的模式。最常用的数据格式是JSON。由于JSON能直接被JavaScript读取，所以，以JSON格式编写的REST风格的API具有简单、易读、易用的特点。 3.所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。说明：对于In...
浅谈编码习惯之注释篇
weixin_30670925的博客
08-22 124
　　软件编码过程中，当注释代码时，要考虑到不仅将来维护你代码的开发人员要看，而且你自己也可能要看。用Phil Haack大师的话来说就是：“一旦一行代码显示屏幕上，你也就成了这段代码的维护者”。因此，对于我们写得好(差)的注释而言，我们将是第一个受益者(受害者)。以下是我个人的简单看法和平常的习惯。 1、模块注释 　　在一个程序模块的开始，应用注释说明模块的名字、功能、开发者和日...
个人对代码注释 & 文档的书写习惯
一些笔记
09-21 986
记录了一些个人对代码注释的书写习惯，目前有python、Matlab、C++、Fortran
八 良好的代码习惯很重要，添加必要注释
somdip的博客
02-28 253
1.https://www.jianshu.com/p/eeb15cc9c6d1 springboot &gt;&gt;&gt;&gt; jar 改 war @&lt;packaging&gt;war&lt;/packaging&gt; @需要加目录webapp,然后在webapp下加WEB-INF目录，在WEB-INF目录新建个web.xml文件，不需要写任何代码 mvnw， mvnw....
几个写代码的好习惯，对写好代码很用帮助
04-27
以下是一些有助于写出更好代码的习惯： 1. **保持代码整洁与一致性**：遵循统一的代码风格和格式，例如，缩进、空格和命名约定。每个函数或方法应保持单一职责，避免过长的代码块。当需要添加新功能时，先考虑如何...
代码中到底应不应当写注释？
10-25
代码的可读性是最重要的质量之一，一个好的开发习惯是在编写代码的同时考虑后来者的阅读体验。当遇到复杂或不易理解的代码逻辑时，应该花时间去重构代码或者编写清晰的注释，而不是仅仅依赖注释。这样不仅有助于当前...
编码规范代码注释模板设置说明手册
04-14
在软件开发过程中，良好的代码注释习惯不仅能帮助开发者更好地理解代码逻辑，还能提高团队协作效率。本手册旨在提供一套统一的代码注释模板，以促进代码的可读性和可维护性。 #### 二、目的与意义 通过制定并遵循...
HTML学习05：良好习惯之代码注释
Blog of Lytracy
07-15 197
文章目录CSS注释HTML注释javascript注释注释的快捷键使用建议 注释是给人看的，计算机并不会执行，网页中不同地方的注释是不相同的。 CSS注释 CSS注释：/* 要注释的css代码 */ HTML注释 html注释：<!-- 在此处写注释 --> 在开始标签中有一个惊叹号，但是结束标签中没有。浏览器不会显示注释，但是能够帮助记录。被注释的内容将不会被渲染和显示。 效果如下： javascript注释 javascript注释如下： // 编写javascript代码 /*
为了写好代码，你坚持了哪些好习惯？
再见孙悟空的专栏
10-02 6133
代码的质量会影响到产品的性能和好坏，代码水平也是程序员业务水平的直观体现，那么我们如何才能写好代码呢？接下来和大家分享一些写好代码的习惯。代码是一环扣一环的，从逻辑、可读、简洁、效率、维护，这些标准都决定了代码的好坏。从看到学再到写，在提升自己代码能力的同时，还要注意代码的质量优化，一个好的程序，是由好的代码模块组合而成的，而在我们写程序的时候就应该多加考虑和设计，这样不仅是对代码负责也是对自己负责，写好优质代码是一个程序员应尽的责任。
养成好习惯 关于代码注释的13个技巧
randyamis的专栏
01-05 828
以下13个小技巧可以使得你的代码在长时间内依然能够保持容易理解和维护。1. 对不同级别的代码进行注释对于不同级别的代码块，要使用统一的方法来进行注释。例如：对于每一个类，需要包含一段简明扼要的描述，作者和上一次修改的时间对于每一个方法，需要包含这个方法的用途，功能，参数以及返回结果当你在一个团队里面的时候，采用一套注释的标准是非常重要的。当然，使用一种大家都认可的注释约定和工具
看懂源码之注释规范
qq_29012777的博客
10-10 5077
1.前言为了增强源代码的可阅读性、结构性，方便代码阅读者对源代码的阅读和理解，以及方便源代码文档的制作和生成，源代码的注释通常按一定的规范编写。 所以要想更好的读懂源码，就必须对注释规范有一定的了解。2.注释详解2.1 定义注释块/*! * 一个注释块 */ 2.2 文件注释块/*! * @file 文件名 * @brief 文件简要说明 * @author 作者 * @date 时间
编码规范(一)----JAVA注释规范
热门推荐
fendo
12-18 3万+
一、前言 好的代码规范是一个程序员的基本修炼，好的代码注释更能体现一个程序员的思维逻辑，虽然代码是用来给机器运行的，我们只要能写出能让编译器运行的代码就行了，但是如果没有好的编码规范，到项目后期，加入开发的人员逐渐增多时，每个人的编码风格都不一样，这就会让项目维护者很难维护，所以开始就要制定一些好的规范来让大家遵守，这样才能写出可维护，健壮的项目，这就是接下来要做的事情。第一节从要从代码
Java注释规范整理
gyhgc的专栏
08-06 1222
在软件开发的过程中总是强调注释的规范，但是没有一个具体的标准进行说明，通常都是在代码编写规范中简单的描述几句，不能作为一个代码注释检查的标准和依据，做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》，内容来自网络、书籍和自己的实际积累。 JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02 一、背景 1、...
编程者必知：代码注释中的5要与3不要
宁静致远
06-04 886
原文  http://developer.51cto.com/art/201506/478686.htm 代码注释，可以说是比代码本身更重要。这里有一些方法可以确保你写在代码中的注释是友好的： 不要重复阅读者已经知道的内容 能明确说明代码是做什么的注释对我们是没有帮助的。 // If the color is red, turn it green if (color
优秀后端都应该具备的开发好习惯
LoveSummer
10-23 2万+
很多小伙伴，判断一个list}这样写呢，逻辑是没什么问题的。}日常开发中，我们既要会用工具类，更要学会自己去总结工具类。比如去文件处理工具类、日期处理工具类等等。这些都是优秀后端开发的一些好习惯。
HashMap为什么线程不安全？
最新发布
rnnf_yyds的博客
11-03 621
HashMap底层是基于数组 + 链表（在 Java 8 以后，当链表长度超过一定阈值时会转换为红黑树）的数据结构。在多线程环境下，当多个线程同时对HashMap进行put操作时，可下面这种情况：假设两个线程 A 和 B 同时执行put操作，它们计算出的插入位置相同（假设为index线程 A 先获取到了当前index位置的节点，在它还没来得及将新节点插入链表（或树）时，线程 B 也获取到了这个位置的节点。
Eclipse快捷键指南：注释与代码操作
"这篇文章主要介绍了Eclipse编辑器中的一些常用快捷键，特别是关于注释的操作，包括单行注释、多行注释以及快速文档注释等。...同时，别忘了根据个人习惯自定义快捷键设置，让工具更好地服务于你。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值