代码规范

来源:互联网 发布:微博个性域名格式 编辑:程序博客网 时间:2024/05/22 14:12

1局部控件变量命名原则:

如定义一个用户名的UITextField,去掉前面的UI,全小写textfield然后加上含义部分驼峰方式命名,UITextField*textfieldUserName;

这样定义为了:使用控件前缀,多个控件时,代码前端整齐,不使用控件缩写防止个人写法有差异,带上含义部分增加代码的可读性。

2 *.m代码方法归类整齐,使用#param mark拆分并注释,注释前后用6个横线

如: #param mark------处理网络请求------

3 比较关键的方法和语句用// 注释,注释需单独占一行,//与下面代码对齐,//与注释间空一格; 比较复杂的逻辑部分,尤其是if else块或switch case块 或是 枚举值,尽量代码注释。

4 #param块间,方法间需空行,方法块内部按照逻辑职责不同可以用空白行分割或直接写清注释,减少多余空白行,最多空一行; 参数过长时可以分行显示,冒号对齐;所有代码必须自动缩进对齐,全选,右键->Structure->Re-Indent。

5 减少语句嵌套,提高代码可读性。

6 删除掉因放弃而注释的代码,如果需要替换成描述性的文字,防止其他人维护时,分不清被注释代码的必要性。
0 0
原创粉丝点击