必要的注释利人利己

我的看法：

写了这么久代码，见到了各式各样、形形色色的代码，也看到了大家对待注释的态度，可以说是又爱又恨又双标……不论时我还是旁边的人，大部分都是看别人的代码恨不得每一行都加上注释，尤其是对于那些刚到公司的小白，可是轮到自己写代码的时候，却是随心所欲，能省就省。渐渐的，我比较倾向于给代码加必要的注释，自己写的时候也会在一些地方专门加上注释，因为对于比较大型的项目，尤其是团队合作的项目，加上注释是绝对是利人利己的。不然自己回头看代码时，会被很多很多的组件、命名弄得晕头转向。虽然写代码最讲究一个“见名知意”，但是需要命名的东西多起来时，你会烦恼，到底起啥名好，弄一个重名了，弄一个太笼统，更何况你起的名字对于团队的其他人可能会会错意，所以注释这时候能帮大忙，可以提高开发效率，也便于日后维护纠错，总的来说利大于弊。

比如：

export type Express = {
  id: string
  content: string
  createTime: string
  status: ExpressStatus
  statusValue: string
}

光看这一串TS声明，相信大部分人都之恶能看到个大概，但是放到已完成项目里就会摸不着头脑，得一个一个比对着去找，到底是哪个配置的声明。自己写的时候都明白的很，但是写完后再去找就会有点费劲，别说别人来看了

这时候必要的注释会让它的作用清晰明了

// 药品物流
export type Express = {
  /** 物流信息ID */
  id: string
  /** 物流内容 */
  content: string
  /** 创建时间 */
  createTime: string
  /** 物流状态 */
  status: ExpressStatus
  /** 状态文章 */
  statusValue: string
}

程序员不写注释的原因到底是什么？

程序员忙起来的时候需要在短时间内敲出来很多代码，这时候挨个写注释就很浪费时间，一个是思维突然活跃起来，思如泉涌，大量的写代码，熟练的程序员心里都有一套自己的逻辑，按照这逻辑写基本不会乱，就下意识地觉得注释没有必要，或者说大量写重复代码觉得写不写都一样，反正自己都能看得懂，主要还是聚焦在一个写代码时的感觉和效率问题上。只不过这样往往给协同开发的人员以及后期维护埋下了隐患，一旦有哪里出了问题后期寻找错误会变得更加费时费力，蓑衣我觉得一写必要的注释是一个好习惯。

当然也有一些“大佬”程序员，为了显示自己的代码多么的厉害，给新人小白展现实力的成分在里面，所以写的代码会用写起来尽量最简单但是最不容易一眼看懂的方式，对于他们来说也不需要加注释，不过对于新加入的同事确实不太友好了

如何才能写出漂亮的注释？

个人看来，必要的地方加注释，但也不是事无巨细的都加，那样反而会影响代码的“美观”，并且会白白耗费很多时间，影响开发效率，写注释的时候可以想想怎么言简意赅的写出下面的代码用途，而不是累赘的啥都写一大串，生怕别人不知道这串代码的所有作用，比如“添加、删除，编辑"等等这些最基础的语言，在一个页面中没有太多重复的就不需要详细解释了，别人会根据页面来了解这个是服务于哪一个具体功能的。并且写的时候尽量独占一行与主代码对齐，提升代码可读性，也显得整齐美观，而不是层次不齐的写了一堆在后面

就比如刚才那串注释，写成这样，大家觉得和上面比怎么样？

// 药品物流
export type Express = {
  id: string   /** 物流信息ID */
  content: string   /** 物流内容 */
  createTime: string   /** 创建时间 */
  status: ExpressStatus    /** 物流状态 */
  statusValue: string   /** 状态文章 */
}

以上仅为个人看法，如有不足敬请指出，欢迎大家和平讨论！