1.编写可读代码的艺术(1~2章节)

本文探讨了编写高质量代码的关键原则,包括可读性、命名规范和代码格式化。强调了选择专业且具象的命名,避免使用模糊词汇,合理命名迭代器,以及在名字中附加信息的重要性。此外,还提到了根据作用域选择合适的变量名长度,并提倡利用首字母缩写和编程规范来增强代码的清晰度。
摘要由CSDN通过智能技术生成

**疑问:**那个代码最好
第一章节
1.可读性原则
代码的写法使得别人理解它所需的时间最少。

2.表面层次改进
好的名字、注释、代码整洁格式(使用适当的空格符)

第二章:把信息封装到名字里
1.选择专业的词
GetPage---->DownloadPage
----->FetchPage
二叉树的size–>[Height, NumNodes, MemoryBytes]
2.避免使用泛泛的词
(1)不好的例子
tmp、retval(returnValue)、foo
(2)修改例子
javaSpcript例子
retrval—>sum_squares
(3)tmp使用场景
tmp = left// 临时场景使用
修改建议
tmp–>修改为具体场景的意义tmp---->user_info
tmp---->tmp_file # 加一个后缀

3.循环迭代器
(1) 表示迭代器的词不要表示其他含义
i,j, k, iter, it
(2)根据场景变为更加精确的名字
i, j, k----->clud_i, members_i //增加前缀
4.用具体的名字代替抽象的名字
(1)例子1
ServerCanStart----->CanListenOnPort
(2)例子2

#define DISALLOW_EVIL_CONSTRUCTORS(ClassName)
    ClassName(const ClassName &);
    void operator=(const ClassName&);

class ClassName {
	private:
	DISALLOW_EVIL_CONSTRUCTORS(ClassName)
};

DISALLOW_EVIL_CONSTRUCTORS------>DISALLOW_COPY_AND_ASSIGN //EVIL这个词太抽象
(3)例子3
—run_locally
当作为可选打印日志意义时:–extra_logging
当—run_locally还有其他意义时:分两种写法–extra_logging、–use_local_database

5.为名字附带更多信息
在这里插入图片描述

变量--------》等价于一个小注释
(1)例子1,包含16进制
string id; ----->hex_id
(2)单位
start---->start_ms
(3)url—>untrustedUrl\trustedUrl
原则:需要理解的关键信息,放在名字里面,不提倡每个变量都加

6.名字应该有多长
在这里插入图片描述

原则:
在小的作用域里面用短名字
输入长名字,可以利用软件的补全功能
首字母缩写原则:团队其他人员均理解
丢掉没用的词:ConvertToString----->toString
利用名字的格式来传递含义----符合编程规范

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值