码迷,mamicode.com
首页 > 其他好文 > 详细

注释风格(前后端通用)

时间:2018-08-03 19:41:15      阅读:170      评论:0      收藏:0      [点我收藏+]

标签:概述   goback   接口   margin   justify   back   注释   rect   ack   

注释风格(前后端通用)

一、注释类型:

1.用标准注释格式隐藏代码而不必删除它们

2.用单行注释解释实现细节

二、注释风格:

1.使用第三人称叙述的形式

2.编写独立的概述

三、注释内容:

1.每个重要的类、接口、字段和方法都编写注释

2.记得署名

四、内部注释:

1.仅添加有助于理解代码的内部注释

2.描写代码为什么这样做,而不是在做什么

3.避免使用行尾注释

注释风格(前后端通用)

标签:概述   goback   接口   margin   justify   back   注释   rect   ack   

原文地址:https://www.cnblogs.com/tilmto/p/9415776.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!