代码风格个性化和结构化

原创
2017/06/09 14:23
阅读数 140

首先说一下,代码风格个性化和结构化在笔者这里的定义: 1. 代码风格个性化是指写出风格一致的代码,不管是在团队项目里,还是个人项目里,有良好风格的代码更加能让人看懂逻辑,赏心悦目 2. 代码结构化是指为整套系统(或是框架)梳理好逻辑,做好结构梳理,很大程度上避免了由于“不专业”所导致的bug

一、 代码风格

每个人都有自己的编码风格,重点说一下空行及换行

空格:
	在代码中,应该合理利用空行;在逻辑代码中,每段都会有相对联系较大的代码,以及相对联系不大的代码,相对紧凑的代码之间就不用使用空行,这样能让逻辑清晰,让看代码的人能够理解,哪部分的逻辑是相对紧凑,哪部分的逻辑联系不是很大


换行:
	在代码中,经常会出现if else 等类似的判断条件,所以也避免不了判断条件过长的时候,合理的换行会让代码更加清晰

二、 代码结构化

1. 在代码中,经常会出现数字,这些数字或是某些限制,或是某些条件,这种数据都统一用枚举实现,写在common里面

2. 整理、理解类与类之间的联系,确定功能与功能之间独立性,不要试图在功能模块A中写上功能模块B的代码,这样不仅增加维护成本,还加大了代码的复杂程度

3. 代码一定要简洁明了,既能让其他人看懂,又能减少不必要的bug出现的几率;例如:现在有一个需求,笔者们需要做一个5杀,同时击杀超过5个,一样算做5杀,正常逻辑代码如下(c++):

	if (kill_count >=5)
		kill_count = 5;
	else
		kill_count += 1;       #假设 已经定义kill_count 为击杀数


改进:

	kill_count = kill_count >= 5 ? 5 : kill_count += 1				#清晰,简洁,明了



4. for循环中,有时候需要遍历,找到其中一个符合条件的值,例如(c++ 代码):
	int k = 0;
	for(int i = 0; i != 10; ++i)
	{
		if (i == 5)
			k = i;
	}									#遍历10次

	改进:
	int k = 0;
	for(int i = 0; i != 10; ++i)
	{
		if (i == 5)
		{
			k = i;
			break;						#遍历5次
		}
	}



5. 多次在程序中出现的工具性代码,应单独整理成一个工具类

6. 基础功能中不要添加和其他功能有关的代码,这是解耦合的思想

总结: 关于写代码,并不是只有写代码,其他边缘化的东西也需要关注,除了笔者上面提到的,还有其他很多需要注意的地方,希望读者多多总结

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部