文档章节

6. 注释

MrZhu
 MrZhu
发布于 2014/12/05 09:48
字数 251
阅读 14
收藏 0

1.    函数注释

(1)函数声明部分注释函数的用法,实现部分注释函数实现的操作。

(2)声明部分注释的信息

a.    输入和输出;

b.    对于类成员函数,在该方法的调用周期外,对象是否有引用参数,它是否会释放这些引用;

c.    如果一个函数申请了内存,它必须释放它们;

d.    参数是否可以是空;

e.    函数的使用方法是否会影响其性能;

f.    如果函数可重入,是怎么实现同步的;


2.    变量注释

(1)所有全局变量应该有一个描述其功能及其意义的注释。


3.    以NULL、true/false、1/2/3等作为参数

(1)函数传入NULL、布尔值和整型值时,应该增加注释说明这些值的意义,或者使用常量使代码自文档化。


© 著作权归作者所有

共有 人打赏支持
下一篇: 5. 命名
MrZhu
粉丝 0
博文 11
码字总数 8476
作品 0
厦门
程序员
私信 提问
MySQL(二)MySQL的安装和简单使用

1、MySQL产品的介绍 MySQL数据库属于MySQL AB公司,总部位于瑞典,后被Oracle收购。 优点: (1)成本低:开放源代码,可以免费使用 (2)性能高:执行很快 (2)简单:很容易安装和使用 2、...

leeqico
2018/05/18
0
0
【java基础】Eclipse Java注释模板设置详解以及版权声明

网上的Eclipse注释模板,在这里稍稍整理一些比较常用的。 编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就...

卯金刀GG
2018/04/23
0
0
NERD_commenter插件快捷键

快捷键: 1、 cc 注释当前行和选中行 2、 cn 没有发现和cc有区别 3、 c 如果被选区域有部分被注释,则对被选区域执行取消注释操作,其它情况执行反转注释操作 4、 cm 对被选区域用一对注释符...

eyunshu
01/22
0
0
[Linux command]批处理注释

在批处理中,段注释有一种比较常用的方法: goto start = 可以是多行文本,可以是命令 = 可以包含重定向符号和其他特殊字符 = 只要不包含 :start 这一行,就都是注释 :start1、:: 注释内容(...

SibylY
2015/03/02
178
7
2、通过BeautifulSoup检索文档中的tag

1、使用find_all()(或者findAll())检索标签 对于BeautifulSoup中的方法,find/findAll()为一组函数,通过不同的参数进行重载。此处没太多书上的含糊细节,具体知识点都在代码注释行。 需要注...

张明旭
2016/03/16
222
0

没有更多内容

加载失败,请刷新页面

加载更多

linux 静态IP、DNS、主机名配置

linux 静态IP、DNS、主机名配置 一、IP配置 进入网络配置文件目录 cd  /etc/sysconfig/network-scripts/ 列出当前目录下文件名 ll 编辑配置文件 注意:ifcfg-eth0是我电脑的一个网卡标识...

小儿
23分钟前
4
0
配置vagrant使用三种网络

使用vagrant安装之后一直使用127.0.0.1进行访问。但是一直使用这个ip肯定满足不了的。我们装肯定是有需求的,那么本节就讲解一下用vagrant的网络配置。 vagrant中一共提供了三种网络配置。 ...

echojson
24分钟前
0
0
重磅发布:阿里开源 OpenJDK 长期支持版本 Alibaba Dragonwell

3 月 21 日北京阿里云峰会,阿里巴巴正式宣布对外开源 OpenJDK 长期支持版本 Alibaba Dragonwell。作为 Java 全球管理组织 Java Community Process (JCP) 的最高执行委员会的唯一中国代表,以...

阿里云官方博客
25分钟前
1
0
重磅发布:阿里开源 OpenJDK 长期支持版本 Alibaba Dragonwell

3 月 21 日北京阿里云峰会,阿里巴巴正式宣布对外开源 OpenJDK 长期支持版本 Alibaba Dragonwell。作为 Java 全球管理组织 Java Community Process (JCP) 的最高执行委员会的唯一中国代表,以...

阿里云云栖社区
30分钟前
0
0
OAuth2实现单点登录SSO

1. 前言 技术这东西吧,看别人写的好像很简单似的,到自己去写的时候就各种问题,“一看就会,一做就错”。网上关于实现SSO的文章一大堆,但是当你真的照着写的时候就会发现根本不是那么回事...

java菜分享
31分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部