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

绝对的要加注释。

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;
}

瞬间吊炸天有木有。

时间: 2024-10-26 05:45:29

关于代码加不加注释的问题的相关文章

动态规划代码 加注释

动态规划的原理就不多讲了,网上一大堆,google一下就明白了,直接上代码 1 public class DynamicPlan { 2 // 100 个人 挖 5 个矿 3 private static int peopleCount=100; 4 private static int poolCount=5; 5 // 挖每个矿时需要的人数 6 private static int[] peopleNeed={77,22,29,50,99}; 7 // 每个矿可以挖出来的金币数 8 priv

js中调用函数时加不加括号的问题

其实总结起来如下:函数只要是要调用它进行执行的,都必须加括号.此时,函数()实际上等于函数的返回值.当然,有些没有返回值,但已经执行了函数体内的行为,这个是根本,就是说,只要加括号的,就代表将会执行函数体代码.不加括号的,都是把函数名称作为函数的指针,用于传参,此时不是得到函数的结果,因为不会运行函数体代码.它只是传递了函数体所在的地址位置,在需要的时候好找到函数体去执行. 所以一般时候我们都是采用的是无括号的原因.这也是由于括号的二义性,因为括号是"函数调用运算符",相当于在执行这样

【js】在js中加HTML注释标签的原因?

<script type="text/JavaScript"> <!-- js代码 //--> //就是这句,为什么还要在-->前加上js注释 </script> 我们偶尔可能会看到上面这样的js注释代码,可是原因是什么呢? 答案: 原因是那些不支持 JavaScript 的浏览器会把脚本作为页面的内容来显示.为了防止这种情况发生,我们可以使用这样的 HTML 注释标签.注释行末尾的两个正斜杠是 JavaScript 的注释符号,它会阻止 Ja

struts2重写request的方法引发的问题!(加不加#号问题)

在Action中我们把jsp需要的数据放到指定的域中,但是在struts2中,你知道struts重写了request对象的getAttrbute()方法: DepartmentAction类中: jsp显示页面中: 我的疑惑是: 我在Action类中ActionContext.getContext().put("departmentList", departmentList);这里到底是放到了哪里,我们知道这里是放到的ActionContext的上下文中, 默认是放到了request域

socket实现人多聊天与Java代码加载过程

第一部分是java代码加载过程 关于java代码加载过程,今天调试了阿里巴巴一份代码,如下: /** * 加载方法不等于执行方法,初始化变量则会赋值 * 类加载顺序应为 加载静态方法-初始化静态变量-执行静态代码块 * 实例化时 先加载非静态方法-实例化非静态变量-执行构造代码块-执行构造函数 * @author panteng * */ public class StaticTest { /**第一个加载*/ public static int k = 0; /**第二个加载,因为是new一个

提高代码可读性的注释技巧 实用型

很多程序员在写代码的时候往往都不注意代码的可读性,让别人在阅读代码时花费更多的时间.其实,只要程序员在写代码的时候,注意为代码加注释,并以合理的格式为代码加注释,这样就方便别人查看代码,也方便自己以后查看了.下面分享十个加注释的技巧:为每个代码块添加注释,并在每一层使用统一的注释方法和风格.例如:· 针对每个类:包括摘要信息.作者信息.以及最近修改日期等;· 针对每个方法:包括用途.功能.参数和返回值等.在团队工作中,采用标准化的注释尤为重要.当然,使用注释规范和工具(例如C#里的XML,Jav

同过代码 加载 storyboard 中的 控制器 controller

一.通过代码加载storyboard文件创建控制器的view   Test.storyboard  前名是文件名,后面的storyboard是文件的扩展名 // 1. 应用程序启动完成,会调用此方法,启动之后,将不再调用此方法!// 如果因为内存等原因,应用程序被操作系统干掉,再次点击图标,会调用此方法! - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)l

swift 代码加载xib storyboard

初学swift,代码加载xib storyboard -.加载xib override init(nibName nibNameOrNil: String?, bundle nibBundleOrNil: NSBundle?){ super.init(nibName: nibNameOrNil, bundle: nibBundleOrNil) } convenience init() { var nibNameOrNil = String?("ViewController") self

Java关于条件判断练习--统计一个src文件下的所有.java文件内的代码行数(注释行、空白行不统计在内)

要求:统计一个src文件下的所有.java文件内的代码行数(注释行.空白行不统计在内) 分析:先封装一个静态方法用于统计确定的.java文件的有效代码行数.使用字符缓冲流读取文件,首先判断是否是块注释开头,接着判断是否是块注释结尾,再判断是否是单行注释或者空白行,若都不是则是有效代码,统计行数+1. 对于文件夹路径,采用递归的方法判断子条目是文件还是文件夹,是文件就调用静态统计方法.源代码: public class CalculateRow { public static void main(