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

关于代码加不加注释的问题

时间:2014-09-16 12:03:00      阅读:212      评论:0      收藏:0      [点我收藏+]

标签:blog   io   ar   div   sp   问题   代码   log   on   

绝对的要加注释。

1,你或许觉得你的代码,自己不加注释也能看懂,但是别人呢,以后接手工作的人呢。

2,现在不加注释,过个两三个月,复杂的逻辑自己就记忆不清晰了,还要看代码想好久逻辑关系。

3,最最主要的是加了规范是代码你不觉得很装逼吗。例子如下;

+ (BOOL)isEmptyObject:(NSObject *)object
{
	if ([object isEqual:[NSNull null]] || object == nil)
	{
		return YES;
	}
	else if ([object isKindOfClass:[NSString class]])
	{
		NSString *string = (NSString *)object;
        
		if (0 == [string length])
		{
			return YES;
		}
	}
    
	return NO;
}

 

/**   
*   对类的说明 标明开发该类模块的作者
*   @version 对类的说明 标明该类模块的版本
*   @see 对类、属性、方法的说明 参考转向,也就是相关主题
*   @param 对方法的说明 对方法中某参数的说明
*   @return 对方法的说明 对方法返回值的说明
*   @exception 对方法的说明 对方法可能抛出的异常进行说明
*   @param 对方法的说明 对方法中某参数的说明
*   @return 对方法的说明 对方法返回值的说明
*   @exception 对方法的说明 对方法可能抛出的异常进行说明
*/
/* 
 *   @author yunis
 *   @param 判断是否为字符串以及字符串是否为空
 *   @param  object  传入参数object
 *   @return BOOL
 *   @exception yes为空或者不是字符串  no 为不为空的字符串
  */
+ (BOOL)isEmptyString:(NSObject *)object
{
    if ([object isKindOfClass:[NSString class]])
	{
		NSString *string = (NSString *)object;
        
		if (0 == [string length])
		{
			return YES;
		}else{
            return NO;
        }
	}
    return YES;
}

 瞬间吊炸天有木有。

关于代码加不加注释的问题

标签:blog   io   ar   div   sp   问题   代码   log   on   

原文地址:http://www.cnblogs.com/yunis/p/3974409.html

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