如何写成优雅的代码(格式篇)

2024-06-19 05:48
文章标签 代码 优雅 格式 写成

本文主要是介绍如何写成优雅的代码(格式篇),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

如何写成优雅的代码(格式篇)
1.关于命名:
我个人比较支持的一种观点是,变量名的描述粒度与其变量作用域密切相关。比如,
如果我们
For($i=0;$i<count($array);$i++){
For($j=0;$j<count($array[$i];$j++){
//do more work...
}
}
这样的类似$i,$j的命名毫无坏处,甚至更利于阅读。i,j,m,n这种约定俗成的循环计数器可以让代码更精简且利于阅读。但是如果出现在
---conf.php----
$n = ’misko_lee’ ;    //name
$a = 18 ;    //age

---index.php ----

Echo $n . ’:’ . $a ;  

这种的代码完全让人一头雾水,比如压缩过的js代码。
如果改成
$name = ’misko_lee’ ;
$age = 18 ;
$adminName = ’misko_lee’ ;
$adminAge = 18 ;
我们如何去命名一个变量名应该与这个变量的作用范围相符。我们应该命名为$n,$name,$adminName,则需要考虑这个变量在多大的范围内使用,使用范围越大应该变量名描述越详细。
好的变量命名不需要注释。

除了命名之外,变量名还应该区分功能。
比如常量。 LOCALHOST_NAME (全大写完整单词,下划线分割)
私有变量: _varName;(声明该变量为私有属性,用于js等无在语言级别上约束的语言)。
类名:MyClass
方法/函数名(myFunc(),_myFunc())
...

以上方式仅仅是一些比较好的经验,总之,好的变量命名可以拒绝描述性的注释。



关于缩进。

我不支持完全按层级缩进的格式。个人认为,缩进超过四层就可以考虑拆分缩进了。
如:
If(){
If(){
If(){
If(){

}
}
}
}


我不喜欢这种缩进,我更喜欢

If(){
If(){

If(){


//第三层
If(){
If(){

}

}


}
}
}




也就是说,不要让文本编辑器出现横滚动条


三,如果某个对象的属性在某一局部区域类被大量引用,请创建变量缓存。

如果出现了
Function func ( &$obj ) {
$obj -> a = $obj -> b + 2;
$obj -> a = ( $obj -> a + 14 ) / $obj -> a;
}

如果出现了这种情况,那么使用
Function func ( &$ obj ) {
$cache = $obj -> a;
$cache = $obj -> b + 2;
$cache = ( $cache + 14 ) / $cache;
$obj -> a = $cache;
}
这种效率会更高。因为对一个对象的成员寻址过程比局部变量的选址过程复杂很多。

四.三元运算符。

如果仅仅是
If( $b ) {
$a = $b;
} else {
$a = false;
}

那么写成 $a = $b ? $b : false;  可能会更容易阅读。

五:关闭资源
无论如何,我们都应该在资源使用完后及时关闭。

比如我们进行了一次mysql_connect();连接。
那么我们必须在所有数据库操作结束后关闭mysql_close();
除非已经到了页脚。


六:
你们已经发现我所有的代码的操作都是有空格隔开的。

每一个笨蛋都可以写出计算机可以运行的代码,只有
程序员才可以写出人可以认识的代码。

原文地址:http://bbs.lampbrother.net/read-htm-tid-150401.html

<script type=text/javascript charset=utf-8 src="http://static.bshare.cn/b/buttonLite.js#style=-1&uuid=&pophcol=3&lang=zh"></script> <script type=text/javascript charset=utf-8 src="http://static.bshare.cn/b/bshareC0.js"></script>
阅读(22) | 评论(0) | 转发(0) |
0

上一篇:和大家探讨:轻量级笔记

下一篇:两例Eclipse不能启动Tomcat服务的处理过程

相关热门文章
  • C++ 将unsigned char数组 ...
  • linux内核的一些预定义...
  • 美国RT服务器租用仿牌网站不二...
  • 北京外资公司注册都需要那些流...
  • text段,data段,bss段,堆和栈 ...
  • IP Sec VPN与NAT破镜重圆
  • 网站导航
  • GoAgent图文设置教程
  • UT2.0正式版下载
  • tomcat6.0配置(含配置视频下载...
  • 大家都是用什么来管理hadoop集...
  • 网站被人挂了吗,添加了些程序...
  • Nginx如何保证不走宕机的那个...
  • 大家谈谈MYSQL客户端和服务器...
  • 以下代码运行后为何会输出5?...
给主人留下些什么吧!~~
评论热议

这篇关于如何写成优雅的代码(格式篇)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1074172

相关文章

Python实现文件下载、Cookie以及重定向的方法代码

《Python实现文件下载、Cookie以及重定向的方法代码》本文主要介绍了如何使用Python的requests模块进行网络请求操作,涵盖了从文件下载、Cookie处理到重定向与历史请求等多个方面,... 目录前言一、下载网络文件(一)基本步骤(二)分段下载大文件(三)常见问题二、requests模块处理

vscode保存代码时自动eslint格式化图文教程

《vscode保存代码时自动eslint格式化图文教程》:本文主要介绍vscode保存代码时自动eslint格式化的相关资料,包括打开设置文件并复制特定内容,文中通过代码介绍的非常详细,需要的朋友... 目录1、点击设置2、选择远程--->点击右上角打开设置3、会弹出settings.json文件,将以下内

SQL Server使用SELECT INTO实现表备份的代码示例

《SQLServer使用SELECTINTO实现表备份的代码示例》在数据库管理过程中,有时我们需要对表进行备份,以防数据丢失或修改错误,在SQLServer中,可以使用SELECTINT... 在数据库管理过程中,有时我们需要对表进行备份,以防数据丢失或修改错误。在 SQL Server 中,可以使用 SE

python实现pdf转word和excel的示例代码

《python实现pdf转word和excel的示例代码》本文主要介绍了python实现pdf转word和excel的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、引言二、python编程1,PDF转Word2,PDF转Excel三、前端页面效果展示总结一

在MyBatis的XML映射文件中<trim>元素所有场景下的完整使用示例代码

《在MyBatis的XML映射文件中<trim>元素所有场景下的完整使用示例代码》在MyBatis的XML映射文件中,trim元素用于动态添加SQL语句的一部分,处理前缀、后缀及多余的逗号或连接符,示... 在MyBATis的XML映射文件中,<trim>元素用于动态地添加SQL语句的一部分,例如SET或W

IDEA如何将String类型转json格式

《IDEA如何将String类型转json格式》在Java中,字符串字面量中的转义字符会被自动转换,但通过网络获取的字符串可能不会自动转换,为了解决IDEA无法识别JSON字符串的问题,可以在本地对字... 目录问题描述问题原因解决方案总结问题描述最近做项目需要使用Ai生成json,可生成String类型

使用C#代码计算数学表达式实例

《使用C#代码计算数学表达式实例》这段文字主要讲述了如何使用C#语言来计算数学表达式,该程序通过使用Dictionary保存变量,定义了运算符优先级,并实现了EvaluateExpression方法来... 目录C#代码计算数学表达式该方法很长,因此我将分段描述下面的代码片段显示了下一步以下代码显示该方法如

python多进程实现数据共享的示例代码

《python多进程实现数据共享的示例代码》本文介绍了Python中多进程实现数据共享的方法,包括使用multiprocessing模块和manager模块这两种方法,具有一定的参考价值,感兴趣的可以... 目录背景进程、进程创建进程间通信 进程间共享数据共享list实践背景 安卓ui自动化框架,使用的是

SpringBoot生成和操作PDF的代码详解

《SpringBoot生成和操作PDF的代码详解》本文主要介绍了在SpringBoot项目下,通过代码和操作步骤,详细的介绍了如何操作PDF,希望可以帮助到准备通过JAVA操作PDF的你,项目框架用的... 目录本文简介PDF文件简介代码实现PDF操作基于PDF模板生成,并下载完全基于代码生成,并保存合并P

SpringBoot基于MyBatis-Plus实现Lambda Query查询的示例代码

《SpringBoot基于MyBatis-Plus实现LambdaQuery查询的示例代码》MyBatis-Plus是MyBatis的增强工具,简化了数据库操作,并提高了开发效率,它提供了多种查询方... 目录引言基础环境配置依赖配置(Maven)application.yml 配置表结构设计demo_st