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

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

相关文章

Flutter监听当前页面可见与隐藏状态的代码详解

《Flutter监听当前页面可见与隐藏状态的代码详解》文章介绍了如何在Flutter中使用路由观察者来监听应用进入前台或后台状态以及页面的显示和隐藏,并通过代码示例讲解的非常详细,需要的朋友可以参考下... flutter 可以监听 app 进入前台还是后台状态,也可以监听当http://www.cppcn

基于Python开发PDF转Doc格式小程序

《基于Python开发PDF转Doc格式小程序》这篇文章主要为大家详细介绍了如何基于Python开发PDF转Doc格式小程序,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 用python实现PDF转Doc格式小程序以下是一个使用Python实现PDF转DOC格式的GUI程序,采用T

Python使用PIL库将PNG图片转换为ICO图标的示例代码

《Python使用PIL库将PNG图片转换为ICO图标的示例代码》在软件开发和网站设计中,ICO图标是一种常用的图像格式,特别适用于应用程序图标、网页收藏夹图标等场景,本文将介绍如何使用Python的... 目录引言准备工作代码解析实践操作结果展示结语引言在软件开发和网站设计中,ICO图标是一种常用的图像

Python如何实现读取csv文件时忽略文件的编码格式

《Python如何实现读取csv文件时忽略文件的编码格式》我们再日常读取csv文件的时候经常会发现csv文件的格式有多种,所以这篇文章为大家介绍了Python如何实现读取csv文件时忽略文件的编码格式... 目录1、背景介绍2、库的安装3、核心代码4、完整代码1、背景介绍我们再日常读取csv文件的时候经常

Java中有什么工具可以进行代码反编译详解

《Java中有什么工具可以进行代码反编译详解》:本文主要介绍Java中有什么工具可以进行代码反编译的相关资,料,包括JD-GUI、CFR、Procyon、Fernflower、Javap、Byte... 目录1.JD-GUI2.CFR3.Procyon Decompiler4.Fernflower5.Jav

javaScript在表单提交时获取表单数据的示例代码

《javaScript在表单提交时获取表单数据的示例代码》本文介绍了五种在JavaScript中获取表单数据的方法:使用FormData对象、手动提取表单数据、使用querySelector获取单个字... 方法 1:使用 FormData 对象FormData 是一个方便的内置对象,用于获取表单中的键值

Vue ElementUI中Upload组件批量上传的实现代码

《VueElementUI中Upload组件批量上传的实现代码》ElementUI中Upload组件批量上传通过获取upload组件的DOM、文件、上传地址和数据,封装uploadFiles方法,使... ElementUI中Upload组件如何批量上传首先就是upload组件 <el-upl

C++使用栈实现括号匹配的代码详解

《C++使用栈实现括号匹配的代码详解》在编程中,括号匹配是一个常见问题,尤其是在处理数学表达式、编译器解析等任务时,栈是一种非常适合处理此类问题的数据结构,能够精确地管理括号的匹配问题,本文将通过C+... 目录引言问题描述代码讲解代码解析栈的状态表示测试总结引言在编程中,括号匹配是一个常见问题,尤其是在

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景