“注释”是程序员的自我修养

开篇引言
公司早会上，项目经理怒气冲冲，大声质问：“这么明显的BUG，谁TM写的，还没有注释，给我查SVN的提交记录，扣除这个程序员的KPI”
项目组的小码农们紧张的空气都凝固了，害怕被揪出来是自己写的。
小王：“经理，我正在查。。。”
过了几分钟。
小王，一脸震惊，口中嘟囔着说：“这不可能吧？怎么会是他？”
众人凑过去一看，错误代码竟然是项目经理两年前自己提交的！
当初要是写上注释，何必今日这么尴尬呀！今天就跟大家聊一聊代码注释！

注释是在程序中添加的说明性信息，方便程序员更好的阅读代码。本文先介绍一下Java中的注释的基本概念和案例，然给大家整理了一些大公司的注释书写规范，供大家参考！

单行注释：

// 我是单行注释

多行注释：

/* 我是多行注释 */

文本注释

/** 我是文本注释 */

举个例子：

/*** @description：演示注释用法的案例程序* @author     ：Code大队长* @date       ：2021-05-25*//** 类名：HelloWorldDemo* 关键字：public、class*/
public class HelloWorldDemo {//这是程序的入口函数，这个地方是固定写法public static void main(String[] args) {//这句话是输出遇见，输出的内容会打印在控制台中System.out.println("Hello World!");}
}

注释的格式没有统一的规范，每个公司可能会稍有区别，我这里有一份阿里巴巴的Java开发手册，里面介绍了注释的相关规定，提供给大家作为参考！

文档下载地址：链接：https://pan.baidu.com/s/16vq8mRQxtx3n9wYz2SFhSQ
提取码：3r51

“注释”是程序员的自我修养相关推荐

《程序员的自我修养》
<程序员的自我修养>这本书偏底层,来来回回读了有三四遍了,每一次都有新的收获,不过很快又会忘记,所以写下了这本书从17年12月份至今的全书的笔记,留作以后自己复习. 第二章:编译和链接源 ...
程序员的自我修养，好文
很认真的聊一聊程序员的自我修养本文正在筹备第二版,以下是第一版主要内容首先要谈的是,今天的话题所聊的程序员包含哪些人? 在中国,写程序,不仅仅是一种兴趣,更多的时候,还是一种普通职业和谋生工具大 ...
很认真地聊一聊程序员的自我修养
最近看了<浅谈程序员的英语学习>,对于文章中的观点我非常认同,英语是非常重要的,但文章站的高度还是太高,具体表述的学习方法我不是很认同,也认为不太实际,恰好之前有一篇一直没有发表的文章想重 ...
一个“程序员的自我修养”是什么？
在<喜剧之王>中,周星驰扮演的尹天仇,一直梦想成为一名演员,而他不管是在扮演跑龙套,或者在街坊中开设演员训练班,亦或成为主角时,他对待演员的态度,始终是认真,热爱而又投入的.而那一本他随身 ...
程序员的自我修养(转载)
疲于加班,幸好我还保留看看别人写的东西的习惯,下面转载的一篇文章,在某些地方触动到了我,有些时候我也是反面典型,思考得少,反而直接拿来用的更多,但是我发现,往往很多问题都是糊里糊涂地用了别人的东西导致 ...
论一个程序员的自我修养
本篇文章转载-转瞬之夏在<喜剧之王>中,周星驰扮演的尹天仇,一直梦想成为一名演员,而他不管是在扮演跑龙套,或者在街坊中开设演员训练班,亦或成为主角时,他对待演员的态度,始终是认真,热爱而 ...
程序员的自我修养阅读笔记
编译和链接将编译和链接合并到一起的过程称为构建(Build). 从源文件生成最终可执行目标文件共有4个步骤: 预处理(Prepressing) 编译(Compilation) 汇编(Assembly ...
一个程序员修炼之道《论程序员的自我修养》
每个程序员修炼之道都是漫长而艰辛的,要想成为一名伟大的程序员,不仅技术全面还要有程序员的自我修养程序员修炼之道阶段之: 找到编码的感觉经过几年的积累,逐渐认识了Java,Python.所学的知识当 ...
程序员的自我修养—链接、装载与库笔记
程序员的自我修养-链接.装载与库笔记内存管理直接使用物理内存地址虚拟内存-分段虚拟内存-分页分页和分段的主要区别段页式代码生成过程预处理编译词法分析语法分析语义分析源代码优 ...
聊一聊程序员的自我修养
今天逛博客园,看到了一篇推荐的文章<浅谈程序员的英语学习>,就点进去看了一下,对于文章中的观点我非常认同,英语是非常重要的,但文章站的高度还是太高,具体表述的学习方法我不是很认同,也认为不 ...

“注释”是程序员的自我修养

“注释”是程序员的自我修养相关推荐

最新文章

热门文章