无意中看了很多代码,大家往往为了更加方便,轻松,而使代码的可读性下降,可读性很重要,无论是对你或者是看你代码的别人。可以这样想,假如过了几年,无意中翻到以前写的代码,你能确保在读懂它的意思吗?同样,也要确保别人也能读懂。在软件工程中,团队合作是很重要的,成员之间的交流更为之重,交流当中也包含了代码的浏览,所以一定要保证代码的美观。
第一: 熟练使用typedef
1. typedef 在 struct和class中的应用
举个例子: 在C语言和C++中,定义结构体的时候。
一个是 struct node
{
int a;
};
而另一个是
typedef struct node
{
int a;
}NODE;
两种方法虽然都是定义一个结构体,但是下面那种更有点技巧,可以使代码变得更简洁,美观,不行,继续看下去。
1. sizeof(struct node)
2. sizeof(NODE)
看着那个更舒服点呢? node结构体名字还是很短的,如果在长点话,然后sizeof多出现几次的时候,第一种方法是不是要头晕了?
当然这只是在C和C++中才会出现的,对于C#和Java就好多了,直接就是定义类型了,不需要重复写struct, class关键字了。
同理,class也是。
class CGameServer
{
private:
int m_member;
public:
int GetMember const { return m_member; }
};
如果发现类的名字有点长,我们可以如下写:
typedef CGameServer Server;
以后定义CGameServer的变量时候,就可以直接这样写:
Server server;
2. typedef 在数据类型中的应用
要定义一个32位无符号变量,在C和C++中比较麻烦,需要这样 unsigned int a;
unsigned 打字很累啊, 对于大系统来说,该类型的变量将会频繁出现了,那么时间久了你会觉得很烦,不要想着用int直接替代unsigned int!
那么有个好方法,那么就是typedef 关键字。
typedef unsigned int uint32;
怎么样?uint32 字母数少了很多,又不会少了表达。
第二合理的空格,换行
(1)括号之间的对其,包括内嵌括号。
{
}
这样容易读代码,而且看着也好看。
(2)如果一条语句过长,可以尝试换一行接着表达,不要一味的写在一行。
if ( ( A >= 0 && A <= 100 ) ||
( B >= 0 && B <= 100 ))
{
}
是不是这样看着也不错?
(3)定义函数或者方法的时候,参数过长也要适当的换行。
int Create(PARAM param1,
PARAM param2,
PARAM param3,
PARAM param4)
{
}
第三 一个模块的代码不宜太多
这里的模块指方法或者函数,如果一个函数定义的代码很多的话,假如一个方法就有几页的代码,你看着会是什么感觉呢?
第四 勤加注释
不要觉得注释很麻烦,因为注释的作用很大,是必要的,你可以选择一些别人不容易看懂的地方添加注释,告诉别人你在这里写了什么,什么功能,原理等等。
第五 模块划分
这里将会涉及到系统架构,设计模式等多方面的知识了,模块如果划分很清晰的话,将大大提升可读性,同时也能使代码更加美观,模块都是清晰的。
以上是自己看了很多代码以及自己的经验所得来的,希望对大家有所帮助!
分享到:
相关推荐
SSTAB不美观?这个来帮您,纯代码让SSTAB变得美观。 只有一个类。。没有控件。
基于SpringBoot+vue的前后端分离权限管理系统,界面美观,代码简洁易读。 基于SpringBoot+vue的前后端分离权限管理系统,界面美观,代码简洁易读。 基于SpringBoot+vue的前后端分离权限管理系统,界面美观,代码...
为了编程在结构上的美观,易读,上传该文档。 C/C++编程 1.前言 2.文件结构 2.1版本和版权声明 3.程序版式 3.1空行 3.2代码行 3.3对齐 2.命名风格 2.1版本和版权声明 2.注释风格
这是一个用于窗体的皮肤使用.可以让你的窗体更加美观. 只需要把该皮肤导入项目则可以使用.
基于SpringBoot+vue的前后端分离权限管理系统,界面美观,代码简洁易读.zip是一个轻量级的,前后端分离的Java快速开发平台,能快速开发项目并交付【接私活利器】 采用SpringBoot、Shiro、MyBatis-Plus、Vue3、...
基于SpringBoot+vue的前后端分离权限管理系统,界面美观,代码简洁易读。
简单且极其美观的动画金字塔效果
基于 .NET Core MVC 的权限管理系统,代码易读易懂、界面简洁美观
为了使测试报告美观易读,引入ReportNG
基于SpringBoot的权限管理系统 易读易懂、界面简洁美观。 核心技术采用Spring、MyBatis、Shiro没有任何其它重度依赖。直接运行即可用 基于SpringBoot的权限管理系统 易读易懂、界面简洁美观。 核心技术采用Spring、...
管理系统系列--基于 .NET Core MVC 的权限管理系统,代码易读易懂、界面简洁美观
表格的CSS代码,让你的表格边框更加细,代码简洁,一看就会明白,关键还有注解.
星级评分JS-简洁美观干净已经去除多余代码
实用美观的JS相册代码实用美观的JS相册代码
可以帮助你格式化java代码,使代码易读,美观。
内置功能 员工管理:员工是系统操作者,该功能主要完成系统用户配置 部门管理:配置系统组织机构(公司、部门、小组)...代码生成:快速生成对单表的增删改查 服务器信息:查看服务器的基本信息 账号密码:admin 123456
所有前端后台代码封装过后十分精简易上手,出错概率低。同时支持移动客户端访问。系统会陆续更新一些实用功能。 性别男,若依是女儿的名字。屌丝男士别来骚扰了。~ 内置功能 用户管理:用户是系统操作者。 部门管理...
管理系统是一种通过计算机技术实现的用于组织、监控和控制各种活动的软件系统。这些系统通常被设计用来提高效率、减少错误、加强安全性,同时提供数据和信息支持。以下是一些常见类型的管理系统: ...
游戏,拯救大行动,C#实现拯救大行动完整源代码,界面大气美观,可以设置游戏难易程度、支持双人游戏,时时计算得和生命值等。只需要 .net 2.0 的运行环境。是学习游戏制作不可或缺的一款小而美的制作。