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

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

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

代码的可读性至上

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

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

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

确保特定类名的第一个字母大写;

使用大小写分离多个单词的命名;

大写常数名,并使用下划线分离单词;

确保特定功能和变量名的第一个字母小写;

注意正确使用缩写。例如,用 max 而不用 maximum。

必要时可使用空格

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

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

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

注释必须易于理解

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

正确使用函数

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

整齐的代码缩进

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

结束语

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

时间: 2024-10-08 20:04:40

转载:每一个程序员要遵守的一些优秀编程风格的相关文章

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

无论你是业余的还是专业的程序员,正确的编程风格,不但有助于提升软件产品的功能,还可以明显减少软件灾难的产生.今天,我们就来探讨一下有助于我们获取更佳编程风格的一些最好的规则. 代码的可读性至上 代码要能可阅读和可理解,就需要格式化成一致的方式.对函数和变量的命名应有意义,注释的表达应该简洁而准确.并且,准确地记录代码中所有棘手的部分是十分重要的.你必须清楚软件程序为什么能工作以及为什么能在所有可能的情况下顺利工作的原因. 遵循正确的命名约定是必须的 当需要给类.函数和变量命名时,你需要遵循以下指

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

无论你是业余的还是专业的程序员,正确的编程风格,不但有助于提升软件产品的功能,还可以明显减少软件灾难的产生.今天,我们就来探讨一下有助于我们获取更佳编程风格的一些最好的规则. 代码的可读性至上 代码要能可阅读和可理解,就需要格式化成一致的方式.对函数和变量的命名应有意义,注释的表达应该简洁而准确.并且,准确地记录代码中所有棘手的部分是十分重要的.你必须清楚软件程序为什么能工作以及为什么能在所有可能的情况下顺利工作的原因. 遵循正确的命名约定是必须的 当需要给类.函数和变量命名时,你需要遵循以下指

如何区分一个程序员是“老手“还是“新手“?

除多年编程经验之外,还有什么能区分一个程序员是“老手”还是“新手”?编程技巧当然是一部分,但它绝非是全部. 聪明的程序员可能比他们的同行拥有更出众的编程技巧,但那不足以说明他们就是“老手”.同样,仅仅因为拥有10年编程经验也并不意味着他们就是高手.在工作岗位上,拥有多年编程经验也不能说明问题.即便没被炒鱿鱼,那也不能提升你的价值. 下面列举的事情是大多数高级程序员都会做的. 1.至少掌握一门编程语言 我相信有些优秀的程序员只懂(并精通)一门编程语言,但在某种程度上而言,这其实会限制一个人的思维.

如何区分一个程序员是“老手“还是“新手“

除多年编程经验之外,还有什么能区分一个程序员是"老手"还是"新手"?编程技巧当然是一部分,但它绝非是全部. 聪明的程序员可能比他们的同行拥有更出众的编程技巧,但那不足以说明他们就是"老手".同样,仅仅因为拥有10年编程经验也并不意味着他们就是高手.在工作岗位上,拥有多年编程经验也不能说明问题.即便没被炒鱿鱼,那也不能提升你的价值. 下面列举的事情是大多数高级程序员都会做的. 1.至少掌握一门编程语言  我相信有些优秀的程序员只懂(并精通)一门编程

根基决定一个程序员会不会被淘汰 --转载

根基决定一个程序员会不会被淘汰 丰厚的薪水,高端的职位和有成就感的事业是人人都想要的,而这些都取决于你每天的认真工作,努力学习和灵活做人上.日子就像一块块砖,你就像是一个泥瓦匠每天在堆砌着你的人生,最终砌出一个宏伟的大厦或是一幢低矮的小屋甚至是堆成一堆瓦砾全取决于你自己. 程序界和软硬搜索件一样都要遵守摩尔定律,也就是说当前的技术知识很快会被替代,你需要不断学习新的东西,否则就会面临着被淘汰的危险.然而,一个人的学习动力和欲望都是有限的,记忆力还会随着年龄的增长而衰退,从这个道理上来说,年龄大的

从一个程序员笑话看软件开发管理(转载)

从一个程序员笑话看软件开发管理 原文出处:猛禽的编程艺术 原文链接:http://blog.csdn.net/raptor/article/details/727299 有一个笑话是这样的: 1. 程序员写出自认为没有Bug的代码. 2. 软件测试,发现了20个Bug. 3. 程序员修改了10个Bug,并告诉测试组另外10个不是Bug. 4. 测试组发现其中5个改动根本无法工作,同时又发现了15个新Bug. 5. 重复3次步骤3和步骤4. 6. 鉴于市场方面的压力,为了配合当初制定的过分乐观的发

一个程序员的自我修养

在网上看到一篇程序员的自我修养,深以为然,不禁摘录一些,勉励自己 一个好的开发人员,应该能够全面.高效.严谨的去处理任何软件程序和业务问题,成为一个好的开发,是一个很有意思的话题,不过无论这个话题如何开展,基础两个字必不可少,虽然代码量是衡量开发能力的重要指标,但仅能够熟练的进行代码编写是不够的,更要能深刻的理解技术原理和业务逻辑,扎实的个人基础和技术基础往往会促进代码的编写,更游刃有余的解决问题. 下面说的一些基础,可能绝大部分开发人员都不会在意甚至忽略,但恰恰这些才是开发大厦的基石. 1.科

转载 一位程序员的妻子讲述她老公教给她了什么

我曾经跟朋友开玩笑说,这个时代,有两种人的妻子应该要受人尊敬,第一种是军嫂,这是毫无争议的,第二种就是像我这样的,程序员的老婆.当然,这个 玩笑半分自嘲半分真.我的本科是穿着大白褂在各种挂着植物.动物.有机化学.无机化学的门牌的实验室里度过的,在显微镜下给三段生的夹竹桃画过横切片图, 在大头针和解剖剪子的辅助下找过蚯蚓的三条神经,闻过带有臭鸡蛋味的硫化氢气体-- 是的,你们都猜对了,我确实是相貌平平,不修边幅,素面朝天的理科女.见了人就开始习惯性地科普:蝴跟蝶,蜻跟蜓,其实是不一样的,还有,白菜

一辈子作为一个程序员,在中国要放下很多东西

最近看了一篇微信文章<程序员的恐惧>,感觉在中国如果要做一辈子的程序开发,可不是一件容易的事情,需要放下很多东西,需要顶得住来自各方面的压力. 生活如此维艰,总是需要很多的经历才会完善人生,而如果只是一直做开发,程序员的世界相对单一,在中国这个人情的社会里,这样的存在会随着年龄的增长与这个社会格格不入的! 以下是转载原文<程序员的恐惧> 国内的架构师到了三十岁以后很多就往理论上跑,而国外的架构师在往上发展的同时保持下面的编程体验,所以国内多水王,而国外则多大师.---江南白衣 软件