每一个程序员要遵守的一些优秀编程风格

无论你是业余的还是专业的程序员,正确的编程风格,不但有助于提升软件产品的功能,还可以明显减少软件灾难的产生。今天,我们就来探讨一下有助于我们获取更佳编程风格的一些最好的规则。

代码的可读性至上

代码要能可阅读和可理解,就需要格式化成一致的方式。对函数和变量的命名应有意义,注释的表达应该简洁而准确。并且,准确地记录代码中所有棘手的部分是十分重要的。你必须清楚软件程序为什么能工作以及为什么能在所有可能的情况下顺利工作的原因。

遵循正确的命名约定是必须的

当需要给类、函数和变量命名时,你需要遵循以下指南:

  1. 确保特定类名的第一个字母大写;
  2. 使用大小写分离多个单词的命名;
  3. 大写常数名,并使用下划线分离单词;
  4. 确保特定功能和变量名的第一个字母小写;
  5. 注意正确使用缩写。例如,用max而不用maximum。

必要时可使用空格

虽然空格对编译器是没有意义的,但是可用于提高代码的可读性。举个例子,你可以在函数间留三个空行。你还可以在函数内使用单独的空行用于分离关键的代码段。

确保代码有一定的可维护性

我们需要确保写出来的代码,换成另一个程序员来调整功能、修复bug,也是明确易懂的。要将函数中关键值用常量来标记,这样我们就可以随时根据需要来改变这些常量值。总而言之,代码必须坚固,能够处理任何类型的输入,然后在不崩溃的前提下,提供预期结果。

注释必须易于理解

注释应该是有意义的,能够清晰地解释所有关于软件程序的内容。注释的数量多少无所谓,质量才是关键。你需要使用/ *注释* /的风格来写注释,以确保位于每个源文件的顶部。此外,你也可以选择在注释中包括你的名字,编写代码的日期,以及简明扼要地说明程序的实际用途。不过,你可以选择省略一些功能明显的注释。你需要遵循的行内注释格式为//注释。

正确使用函数

每一个函数所包含的代码片段,必须既短又能够完成特定的任务。不妨将函数当作是“黑盒子”——独立,又可以有效处理任何类型的输入。不要忘记这样一条经验规则——即所谓的“Ten Line Rule”,也就是说,一个函数,通常说来,如果超过10行,那就需要以最精炼的方式去简化。并且,任何重复性的代码片段都应该被设置为一个单独的函数。上述做法不但可缩短程序的长度,还能大大提高其可读性。

整齐的代码缩进

缩进在软件程序的流程控制上起着至关重要的作用。每一个新的while、for、if语句,以及switch结构,都需要缩进代码。这也可用于一行语句中括号已被省去的情况。例如,假设有if语句,那么相应else语句必须一齐缩进。

结束语

如果你熟悉了这些正确的编程风格,那么编写软件程序就会成为一个非常有趣的活动。最后希望本文能对各位有所裨益。如有不同见解,欢迎一起探讨。

译文链接:

http://www.codeceo.com/article/programming-style.html

英文原文:

Want A Proper Programming Style? Here Are Rules You Need To Follow

翻译作者:码农网 – 小峰

原文发布于微信公众号 - Crossin的编程教室(crossincode)

原文发表时间:2015-04-26

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏生信技能树

生物信息Python从入门到精通

编者注:本文来自生信编程直播课程讲师投稿,点击阅读原文可以跳转到大神的博客,欢迎点击! 以下为文章全文: Python开发的方向太多了,有机器学习,数据挖掘,...

715120
来自专栏Jimoer

Java设计模式学习记录-模板方法模式

模板方法模式,定义一个操作中算法的骨架,而将一些步骤延迟到子类中。使得子类可以不改变一个算法的结构即可重新定义该算法的某些特定步骤。

20240
来自专栏木可大大

漫谈计算机语言

面对需求人员不断提出的变态需求,软件开发人员的主要工作就是将需求人员口中或文档中的自然语言翻译成计算机能够理解的形式语言。自然语言指的是人类的语言,比如汉语、英...

549240
来自专栏Java后端技术栈

如何通过软引用和弱引用提升JVM内存使用性能!

初学者或初级程序员在面试时如果能证明自己具有分析内存用量和内存调优的能力,这相当有利,因为这是针对5年左右相关经验的高级程序员的要求。而对于高级程序员来说,如果...

11520
来自专栏程序员互动联盟

Java最大的竞争对手是谁?

Java的不断发展要归功于C、C++ 和C# 等编程语言的不断挑战。C++、C#和Java等编程语言基本上都来源于C语言但又有很多区别。业内人士经常将C比作爷爷...

417110
来自专栏java学习

Java每日一题_关于变量的使用

答:在【类里面】声明的变量叫全局变量,全局变量也叫成员变量,全局变量,在全局作用域下申明的变量没有被手动赋值的却在程序中被使用的情况下,将被赋予初值:

10530
来自专栏Java架构师进阶

编写高质量代码的思考

最近在看《代码大全》,可以说是一本软件开发的百科全书,特别厚,但是干货也很多。平时写代码,代码规范是一个最低的要求(很多老代码连最低要求都达不到),为什么要这样...

11220
来自专栏儿童编程

Python常用函数汇总(数据结构、文件类)

Python提供了大量处理各类数据结构(字符串、列表、元组、字典)及文件类(包括文件夹)的函数,为我们进行相关操作提供了极大的便利。

49210
来自专栏编程

《3》 python语言基础知识

「3」python语言基础知识 Python是一种计算机编程语言。计算机编程语言和我们日常使用的自然语言有所不同,最大的区别就是,自然语言在不同的语境下有不同的...

39190
来自专栏java工会

编写高质量代码的思考

最近在看《代码大全》,可以说是一本软件开发的百科全书,特别厚,但是干货也很多。平时写代码,代码规范是一个最低的要求(很多老代码连最低要求都达不到),为什么要这样...

10600

扫码关注云+社区

领取腾讯云代金券