提高代码可读性的10个技巧
来源：互联网 发布：java log日志打印 编辑：程序博客网 时间：2024/05/22 13:28
在本文中，作者从注释，缩进，代码分组，命名方式等方面，介绍了10个提高代码可读性的技巧，供读者学习和借鉴。
以下为译文：
如果你的代码很容易阅读，这也会帮助你调试自己的程序，让工作变得更容易。
代码可读性是计算机编程领域的一个普遍课题，这也是作为开发人员首先要学习的东西。本文将详细介绍几个编写可读代码的最佳实践。
1. 注释和文档
IDE(集成开发环境)在过去的几年里取得了很大的提升，也让你的代码比以前更容易进行注释了。注释会遵循一定的标准，这就允许IDE和其他工具以不同的方式来使用它们。
考虑一下这个例子:
在函数定义中添加的注释可以在使用该函数时进行查看，即使是在其他文件中使用该函数也同样可以查看注释。
下面是另一个例子，从第三方库调用函数:
在这些示例中，使用的注释(或文档)的类型基于PHPDoc，而IDE则是基于Aptana。
2. 一致的缩进
你可能已经知道需要对代码进行缩进，然而，同样值得注意的是，保持缩进样式一致也是很重要的。
缩进方式不止一种，下面是两个比较常见的例子。
方式1:
function foo() { if($maybe){ do_it_now(); again(); } else{ abort_mission(); } finalize();}方式2:
function foo(){ if($maybe) { do_it_now(); again(); }else{ abort_mission(); } finalize();}我曾经使用方式2来编写代码，但最近切换到方式1。这只是一个偏好的问题，没有一种风格是“最好”的，不需要每个人都来遵循。实际上，最好的风格是一致的风格。如果你是团队的成员，或者你正在为一个项目编写代码，那么你应该遵循该项目中正在使用的样式。
当然，缩进样式并不总是完全不同，有时，它们也会混合不同的规则。例如，在PEAR编码标准中，大括号“{”会与控制结构保持一致；但是，它们也会被放在函数定义后的下一行。
PEAR Style
function foo(){ //placed on the next line if($maybe) { // placed on the same line do_it_now(); again(); } else { abort_mission(); } finalize();}另外，请注意，这里使用的是四个空格，而不是使用tab键进行缩进。
这是一篇维基百科的文章，有不同缩进风格的样式。
3 避免冗余的注释
对你的代码进行注释是很棒的行为，然而，它可能是过量的，或者是冗余的。来看这个例子:
// get the country code$country_code = get_country_code($_SERVER['REMOTE_ADDR']);// if country code is USif ($country_code == 'US'){// display the form input for stateecho form_input_state();}当内容很显而易见的时候，进行重复的注释是很没有效率的。
如果你必须对该代码进行注释，那你可以简单地将其合并到一行中:
// display state selection for US users$country_code = get_country_code($_SERVER['REMOTE_ADDR']);if ($country_code == 'US'){echo form_input_state();}4. 代码分组
通常情况下，某些任务需要几行代码，那么把这些任务放在单独的代码块中是一个好主意，这会让它们之间有一些空间。
这里有一个简化的例子:
// get list of forums$forums = array();$r = mysql_query("SELECT id, name, description FROM forums");while ($d = mysql_fetch_assoc($r)){$forums[] = $d;}// load the templatesload_template('header');load_template('forum_list', $forums);load_template('footer');在每个代码块的开头添加注释，视觉上看起来就是分离的代码块了。
5. 一致的命名方案
PHP有时会犯不遵循一致命名方案的错误：
strpos() vs. str_split()
imagetypes() vs. image_type_to_extension()
首先，命名应该有单词边界。有两种比较流行的选择:
camelCase(骆驼拼写法)：除了第一个单词,每个单词的第一个字母都大写。
underscores(下划线)：在单词之间加下划线，例如:mysql_real_escape_string()。
类似于前面提到的缩进方式，命名方式也会有不同的选择。如果现有的项目遵循一定的方案，那么你应该使用它。此外，一些语言倾向于使用一种命名方案。例如，在Java中，大多数代码都使用camelCase方式来命名，而在PHP中，大部分代码都使用underscores命名方式。
当然这些方式也可以混合，一些开发人员倾向于使用underscores方式来处理过程函数和类名，但却使用camelCase方式来对类方法命名:
classFoo_Bar{publicfunctionsomeDummyMethod(){}因此，没有所谓的“最佳”风格，仅仅是需要一致的风格。
6. DRY Principle（干燥原理）
DRY意思是不要重复，即DIE: Duplication is Evil.（复制是邪恶的）
原则如下:
“每一条知识都必须在一个系统中有一个单一的、明确的、权威的表示。”
大多数应用程序(或一般计算机)的目的是使重复的任务自动化，所以这项原则应该在所有代码中体现出来，甚至是web应用程序。同样的代码不应该一次又一次地重复。
例如，大多数web应用程序由许多页面组成，很有可能这些页面包含公共元素，就比如页眉和页脚。然而，将这些页眉和页脚粘贴到每个页面并不是一个好方法。下面是Jeffrey Way解释如何在CodeIgniter中创建模板。
$this->load->view('includes/header'); $this->load->view($main_content); $this->load->view('includes/footer');7. 避免嵌套太深
嵌套过多会使代码更难读取和跟踪。
functiondo_stuff(){// ...if (is_writable($folder)){ if ($fp = fopen($file_path, 'w')){ if ($stuff = get_some_stuff()){ if (fwrite($fp, $stuff)){// ... } else { returnfalse; } } else{为了便于阅读，通常可以修改代码以减少嵌套级别:
functiondo_stuff(){// ...if (!is_writable($folder)){returnfalse;}if (!$fp = fopen($file_path, 'w')){returnfalse;}if (!$stuff = get_some_stuff()){returnfalse;}if (fwrite($fp, $stuff)){// ...} else{returnfalse;}}8. 限制行的长度
眼睛在阅读高而窄的文本时会更舒服，这正是报纸文章看起来是这样的原因:
避免编写太长的代码行是一个很好的做法。
//bad$my_email->set_from('test@email.com')->add_to('programming@gmail.com')->set_subject('Methods Chained')->set_body('Some long message')->send(); // good$my_email ->set_from('test@email.com') ->add_to('programming@gmail.com') ->set_subject('Methods Chained') ->set_body('Some long message') ->send(); // bad$query= "SELECT id, username, first_name, last_name, status FROM users LEFT JOIN user_posts USING(users.id, user_posts.user_id) WHERE post_id = '123'"; // good$query= "SELECT id, username, first_name, last_name, status FROM users LEFT JOIN user_posts USING(users.id, user_posts.user_id) WHERE post_id = '123'";而且，如果有人打算从终端窗口读取代码，比如Vim用户，那么将行长度限制为大约80个字符是一个比较好的做法。
9. 文件和文件夹结构
从技术上讲，可以在一个文件中编写整个应用程序的代码，但这一定是阅读和维护代码的噩梦。
在我的第一个编程项目中，我有创建“include files”的想法，然而还没有完全构建起来。我创建了一个“inc”文件夹，其中有两个文件db.php和functions.php。但随着应用程序的增加，函数文件也变得非常庞大，越来越不可维护。
最好的方法之一是使用框架或模仿文件夹结构。这就是CodeIgniter的样子:
10. 一致的临时命名
通常，变量应该是描述性的，并且包含一个或多个单词。但是，这并不一定适用于临时变量，它们可以像一个字符一样短。
对于相同类型的临时变量，使用一致的命名是很好的做法。下面是我在代码中使用的一些例子:
// $i for loop countersfor($i= 0; $i
相关文章推荐
提高代码可读性的10个注释技巧
很多程序员在写代码的时候往往都不注意代码的可读性，让别人在阅读代码时花费更多的时间。其实，只要程序员在写代码的时候，注意为代码加注释，并以合理的格式为代码加注释，这样就方便别人查看代码，也方便自己以后...
提高代码可读性的10个注释技巧
很多程序员在写代码的时候往往都不注意代码的可读性，让别人在阅读代码时花费更多的时间。其实，只要程序员在写代码的时候，注意为代码加注释，并以合理的格式为代码加注释，这样就方便别人查看代码，也方便自己以后...
提高代码可读性的10个技巧
转自：http://blog.csdn.net/dev_csdn/article/details/78285386 原文：10 Tips for Improving the Read...
提高代码可读性的十大注释技巧
很多程序员在写代码的时候往往都不注意代码的可读性，让别人在阅读代码时花费更多的时间。其实，只要程序员在写代码的时候，注意为代码加注释，并以合理的格式为代码加注释，这样就方便别人查看代码，也方便自己以后...
提高代码可读性的 10 个技巧
作者丨Manas Sadangi 翻译丨Teixeira10 在本文中，作者从注释，缩进，代码分组，命名方式等方面，介绍了10个提高代码可读性的技巧，供读者学习和借鉴。 以下为...
提高代码可读性的十大注释技巧
很多程序员在写代码的时候往往都不注意代码的可读性，让别人在阅读代码时花费更多的时间。其实，只要程序员在写代码的时候，注意为代码加注释，并以合理的格式为代码加注释，这样就方便别人查看代码，也方便自己以后...
提升代码可读性的 10 个技巧
具有较强可读性的代码，能帮助你调试程序，不让自己活得太累。 代码可读性是计算机编程领域中普遍存在的问题。这也是我们成为开发者首先要学习的事情之一。本文会详细介绍在编写强可读性代码时最...
提升代码可读性的 10 个技巧
来自：开源中国社区 链接：https://www.oschina.net/translate/10-tips-how-to-improve-the-readability-of-your-sof ...
提升代码可读性的 10 个技巧
具有较强可读性的代码，能帮助你调试程序，不让自己活得太累。 代码可读性是计算机编程领域中普遍存在的问题。这也是我们成为开发者首先要学习的事情之一。本文会详细介绍在编写强可读性代码...
提高代码可读性： 命名技术
Eclipse打包Android混淆代码降低代码可读性时，出现的Warning:can't find referenced class问题的解决方案
原来用Eclipse打包apk从未想过安全性，即使apk被反编译了，别人也看不懂代码，因为代码的类名都是a,b,c,d等，大大降低了代码的可读性。 这次负责的项目和离线支付有关，所以领导要求必须确保代...
as3加密入门-3降低反编译代码可读性的代码书写习惯
这里不推荐源代码中使用无意义的变量名，如 var asd=new Sprite();function asdf();复制代码源代码中尽量使用有意义的变量名，然后使用第二部分方法混淆即可。我推荐的书写习...
10个有用的排版技巧提升你网站的可读性
排版在网页设计中经常被忽略。其实这是很傻逼的，因为注重网页排版确实可以提高你的网页设计水平和可读性。下面，我列出了10个非常有用的排版技巧让你的网站看起来更好。 1、纠正行高 最常见的网页布局错误...
C语言宏定义技巧，写好C语言，漂亮的宏定义很重要，使用宏定义可以防止出错，提高可移植性，可读性，方便性 等等
你不知道的10个javaScript代码技巧
10个 jQuery 小技巧/代码片段(未测试)
收集的10个 jQuery 小技巧/代码片段，可以帮你快速开发。 1. 返回顶部按钮 你可以利用 animate 和 scrollTop 来实现返回顶部的动画，而不需要使用其他插件。 /...
提高3D打印成功率的10个小技巧
提高WordPress博客安全性10个技巧.doc
编写优秀代码的10个技巧
作为程序员，写代码是需要一种崇高无上的精神来支撑的，写出优秀的代码，更需要你有深厚的底蕴和良好的编码习惯。在介绍写优秀代码的10个技巧之前，我们先来探讨一下什么样的代码才是优秀的代码。 稳定可...
编写优秀代码的10个技巧
编写优秀代码的10个技巧 作为程序员，写代码是需要一种崇高无上的精神来支撑的，写出优秀的代码，更需要你有深厚的底蕴和良好的编码习惯。在介绍写优秀代码的10个技巧之前，我们先来探讨...
10个提高Canvas性能技巧
程序设计修养,对于想把C代码写的漂亮和可读性更高的人而言很不错
你必须知道的10个提高Canvas性能技巧
你还在抱怨自己写的canvas demo徘徊在10帧以下吗？你还在烦恼打开自己写的应用就听见CUP风扇转吗？你正在写一个javascript Canvas库吗？那么下面九点就是你必须知道的！...
如何编写可读性好的代码
SQL查询性能提高的10个技巧
记录详细的需求文档 在写SQL之前必须弄清楚需求, 具体要取什么数据, 有些什么具体的约束条件, 在数据仓库环境中还可以考虑补上这个需求具体对应哪些报表, 对应的基础表如何. 到开发环境的话, 可以...
你必须知道的10个提高Canvas性能技巧
你还在抱怨自己写的canvas demo徘徊在10帧以下吗？你还在烦恼打开自己写的应用就听见CUP风扇转吗？你正在写一个javascript Canvas库吗？那么下面九点就是你必须知道的！ 一.预...
你必须知道的10个提高Canvas性能技巧
你还在抱怨自己写的canvas demo徘徊在10帧以下吗？你还在烦恼打开自己写的应用就听见CUP风扇转吗？你正在写一个javascript Canvas库吗？那么下面九点就是你必须知道的！ 一...
卖家必知：10个淘宝刷单技巧轻松提高店铺销量
卖家必知：10个淘宝刷单技巧 轻松提高店铺销量，小编认为不少进入淘宝开店的新手卖家，对于新品宝贝的排名和曝光可谓是伤透了脑子。如今淘宝规则如此苛刻，如何在夹缝中求生存。淘宝刷单成为了商家们的首选，那么...
如何编写复用性、可读性和可维护性的代码
- 平时我们在写HTML、CSS时会为类的命名耗费脑汁，本文总结了一下平时编码的心得CSS结构化组织思想 目的是讲用户界面划分为独立的块，即使使用复杂的UI，这也使界面开发变得简单快捷，并且...
代码里直接返回对象造成的可读性、扩展性以及性能问题
错误严重度 不会引起较大故障，但对代码可读性、扩展性以及性能会产生一定影响 错误案例 代码里直接返回值，例如获得一个boolean值，例如： …… return true； 或者 return fal...
编写可读性代码的艺术（一）
1.代码应该易于理解 第一部分 表面层次的改进 1.把信息装在名字里 a.找到更有表现力的词 b.避免像tmp和retval这样泛泛的名字 tmp这个名字只应用于短期存在切临时性位其...
编写可读性代码的艺术.docx
编写可读性代码的艺术
你必须知道的10个提高Canvas性能技巧
你还在抱怨自己写的canvas demo徘徊在10帧以下吗？你还在烦恼打开自己写的应用就听见CUP风扇转吗？你正在写一个javascript Canvas库吗？那么下面九点就是你必须知道的！ 一...
你必须知道的10个提高Canvas性能技巧
你还在抱怨自己写的canvas demo徘徊在10帧以下吗？你还在烦恼打开自己写的应用就听见CUP风扇转吗？你正在写一个javascript Canvas库吗？那么下面九点就是你必须知道的！ 一...
10个提高网站可用性的实用技巧
不论是企业网站、个人博客，或者购物网站、游戏网站，我们都希望能吸引访问者并且给他们留下愉快的访问体验。 可用性是用户体验的一种度量，它可以用访问者完成网站功能的方便程度来描述——无论是通过自身知...
注意代码的规范和可读性
注意代码的规范和可读性
编写更加稳定、可读性强的JavaScript代码
每个人都有自己的编程风格，也无可避免的要去感受别人的编程风格——修改别人的代码。”修改别人的代码”对于我们来说的一件很痛苦的事情。因为有些代码并不是那么容易阅读、可维护的，让另一个人来修改别人的代码，...
什么代码叫简洁~什么叫"可维护性，可读性，抽象 = 好！"
一日，你查看你的程序代码，你有两大块代码看起来几乎完全的一样。 事实上它们就是完全一样，除了一个代码里说的是“Spaghetti(意大利面条)”， 另一个代码里说的是“Chocolate Moo...
如何提升代码的可读性
1、先写注释，再写代码；理清思路再动手 （1）清晰的思路是编程行动的良好指南 花点时间思考一下，不要一接到任务就动手编代码，从而陷入技术细节不可自拔...
李炯明：如何高效的与猎头机构合作--最实用的10个小技巧
DB2性能调整的10个技巧
Word排版常用的10个技巧
10个管理工作时间的小技巧
构建高性能J2EE应用的10个技巧
VB6.0初学者的10个编程小技巧
不可错过的10个Lightroom快速修图技巧
eclipse调试java的10个技巧
10个C#编程和Visual Studio使用技巧
10个技巧帮你搞定IE 6
OpenGL蓝宝书第五章5.4Tunnuel 纹理映射和过滤：较好的可读性代码
主要处理了纹理贴图和顶点映射的关系。根据法线先确认环绕方向。然后根据绘制的primitive_type完成纹理顶点直接的映射。哪里来，哪里回；根据法线来确认逆时针方向。strip的画法要熟悉，从其实的...
高质量代码有三要素：可读性、可维护性、可变更性
今天这堂培训课讲什么呢？我既不讲Spring，也不讲Hibernate，更不讲Ext，我不讲任何一个具体的技术。我们抛开任何具体的技术，来谈谈如何提高代码质量。如何提高代码质量，相信不仅是在座所有人苦...
5个提高你站点可读性的方法
养成C++编程好习惯提高程序可读性_之注释篇
[DB][ORACLE]SQL中使用WITH AS提高性能和可读性
利用WITH AS子句提高SQL的性能和可读性 一、 原理 WITH AS短语，也叫做子查询部分（subquery factoring），可以让你做很多事情，定义一个SQL片断，该...
python 2-2 如何为元组中的每个元素命名, 提高程序可读性-collections.namedtuple
解决方案:1.使用下标 定义类似其语言的枚举类型，也就是定义一系列的数值常量 NAME,AGE,SEX,EMAIL=xrange(4) student=(‘jim’,16,’male’,’wei...
10个你未必知道的CSS技巧
项目管理的10个技巧推荐，教你如何选择项目管理软件
提高PHP代码质量的36个技巧
1.不要使用相对路径 常常会看到: 1 require_once('../../lib/some_class.php'); 该方法有...
构建高性能J2EE应用的10个技巧
代码阅读技巧-编程能力提高的最有效途径
利用四维优化技术理念提高网站权重的10个方法
10个方法提高你的编程生产力
C#语言规范3.0最新版,语法完整,解说详细,可读性很强的一本书！对学习C#的人来说有很大的帮助！是C#爱好者的良师益友
整理出15个Android很有用的代码片段(技巧)
《WindowsPhone8开发技巧与案例精解》迷你书+全书代码
Java代码常用技巧
asp19个基本技巧代码下载
VB. NET高级编程技巧笔记及示例代码
构建高性能J2EE应用的10个技巧xibu223
vb使用的10个小技巧
UE的10个技巧
HR 10个实用技巧
DevExpress的10个使用技巧
10个网页代码
jquery的10个常用代码
10个常用CSS代码片段（DOC文档）
10个有用的PHP代码
10个C#Socket编程代码示例.zip
- 提高代码可读性的10个技巧
- 提高代码可读性的 10 个技巧
- 提高代码可读性的10个技巧
- 提高代码可读性的10个技巧
- 提高代码可读性的10个技巧
- 提高代码可读性的10个技巧
- 提高代码可读性的10个技巧
- 提高代码可读性的10个技巧
- 提高代码可读性的10个注释技巧
- 提高代码可读性的10个注释技巧
- 提升代码可读性的 10 个技巧
- 提升代码可读性的 10 个技巧
- 提升代码可读性的 10 个技巧
- 提高代码可读性的注释技巧
- 提高代码可读性的十大注释技巧
- 提高代码可读性的十大注释技巧
- 提高代码可读性的十大注释技巧
- 提高代码可读性的十大注释技巧
- springboot：如何优雅的使用mybatis
- 【十九】机器学习之路——朴素贝叶斯分类
- AI会让人类失业吗？ 马云马化腾们不这么认为
- App数据分析到底要分析什么
- scan camera
- 提高代码可读性的10个技巧
- 设计模式（二十八）------23种设计模式（20）：外观模式
- 如何一步步从数据产品菜鸟走到骨干数据产品
- 第七周实践项目4 队列数组
- jdk1.7 HashMap的实现原理
- 阿里PM的可用性测试秘籍：有理有据的用户体验优化
- java网络编程 udp
- 如何从无到有搭建to B平台？
- vue
