代码添加注释规范
2011-07-01 15:25
246 查看
没有注释的代码就是一坨屎,又烂又臭。
在写代码时就应该添加注释,这时在你的脑子里的是清晰完整的思路。
如果在代码最后再添加注释,它将花费你双倍的时间。
1、对每个类添加注释:包括摘要信息,作者信息,最近修改日期等;
2、对每个方法添加注释:包括用途、功能和返回值。
3、对一些变量添加注释;
4、用TODO标签表示该段代码还未完成;
在写代码时就应该添加注释,这时在你的脑子里的是清晰完整的思路。
如果在代码最后再添加注释,它将花费你双倍的时间。
1、对每个类添加注释:包括摘要信息,作者信息,最近修改日期等;
// AppReviewAlertView.h // iSuzhouCity // // Created by Chen Nan on 5/24/11. // Copyright 2011 Yulong. All rights reserved. // // Utility classes // Prompts users to rate the app via App Store, // if they have use the app for defined days and defined times. // // Revision History // 2011-05-24 | Charles | First draft. // 2011-06-29 | Charles | 设置产品化的参数.
2、对每个方法添加注释:包括用途、功能和返回值。
/* Must Call this method at the end of app delegate's application:didFinishLaunchingWithOptions: method. The rating alert can also be triggered by appEnteredForeground: and userDidSignificantEvent: (as long as you pass YES for canPromptForRating in those methods). */ + (void)appLaunched:(BOOL)canPromptForRating;
3、对一些变量添加注释;
4、用TODO标签表示该段代码还未完成;
// TODO: implement the datepickview
相关文章推荐
- 代码规范之在函数之前添加注释
- 给php代码添加规范的注释phpDocumentor
- 给php代码添加规范的注释
- 给php代码添加规范的注释phpDocumentor
- 【安装】VS2010中为类、函数代码添加版权注释信息
- Java代码注释和编码规范
- 使用VAssistX为VS2008 c++代码添加函数头注释
- C/C++ 代码规范: 命名规则、注释、格式
- eclipse中(代码块)[注释][缩进]和(相关名称)[重命名],Python[编码规范]
- iOS xcode 安装插件 包括---- /// 添加注释 以及 输入代码行提示 等
- PHP Document 代码注释规范
- Eclipse 代码规范 注释模板
- 是雏还是鹰——编程规范之代码注释
- PHP Document 代码注释规范
- vs2008中添加“我的模板”,代码自动加版权注释
- iOS 给代码添加注释
- 代码注释规范-google版本
- PHP代码注释规范
- 手把手教你写_“华为”_的标准注释与文档,以及代码规范
- Eclipse代码规范,注释