养成c++编程好习惯提高程序可读性——之注释篇.pdf

收藏

编号:20181110221253390240    类型:共享资源    大小:234.52KB    格式:PDF    上传时间:2019-02-16
  
2
金币
关 键 词:
提高程序可读性 程序注释 C++ 养成良好的 pdf 可读性 好习惯 提高可读性 编程习惯 增加可读性 C++程序 编写程序
资源描述:
科技信息 0 IT 1A坛^矗-o SCIENCE&TECHNOLOGY INFORMATION 2009年第21期 养成C++编程好习惯提高程序可读性 ——之注释篇 邓宁字 《广娜大学肇软赣斧学院赣律工程系 广东广烂 510990j f攘蒌l黎成起'妥}辩缡程嚣浸靖簌静戆开发、维妒与再秀发至美重要。誊文器据簿者多事款停矛发赫经验,舒辟秘、中缎e++语言程序瑟 静蠡渗C÷÷诺富约有钱验妁(=:语言程序羹,姣鑫学、教学、软辞毋交蟪煮度簿述并烈摹了提高程序代鹞可读撼的一癌要点。希望箍诧帮磅 c++裙学者少走篾钍路。对中缀程序受则可改遗一些不当酌孵习惯,建立秀巩固良好的编程哥慎;靖予港蜂和塘亩}|孝,可提高教学效果和蠹身 专业知识、能力{对于领碍管髓搿翦嘻可通过在这方面的重视来改进邵些在写“可运行代码,而幂最高效代码”的糕序员.以加强对项羁的管理和 效率的提高。 I关键词】c++;演释;优化代鹚;可读性 优化代码的可谈悭非常藤戮。稷序町瀵性的提高不仅使代码外观 整洁、清晰,更负有条理性.蒯.教篱代码的描述,如代码的目的、意图和 行为等。可读性好的稔净瓤容易被理解和维护,它在很大程度上决定 软件工程的开销。 有的人认为编稷没什么燃的.没必鼹设这么多规矩,按自己的喜 好去做,能够解决问题就行丁。的确,没有一种编程方法、风格是最好、 最完美的。但必须指出。袋螋编穰方式事实上就是比其它方式对代码 的优化更有利和有效,产生的影响也霆大;丽疑,观实社会也需要不弼 的编强风格和方法,聪遗斑不潮鼢环境翻要求。所戳。需要我察对常用 的、适于不霹臻况的缔稔蕊格都鑫…定鼹了藕。弱聪逐要漫意+无论栗 爱彝静甄格秘方法编程,郝废谈攀始至终鼙持巍溺一瑷瑟或簿决方案 里使焉滚形式。程序{弋鼹瓢楱的述起链嚣鬻萋要,在蠢一令饔瑟凌方 囊中像穆辩辩甄桡缟写代鹈,耱蹙鼹筒代鹃霹读整懿最饕攀辩、蓄要 寝采取戆方法。 缡霉我羁懿鼹穰包掭注释、l℃羁段簿辩、名稔(热变蒸名、函数、类 型等)、代鼹络梅、器常照壤嚣整本瑟豢。在这墼,注我麦臻各整浚浚注 释翦黎藏往嚣羹簧怒。 舂翡程序爨,霓藻褥学卷耨襁缀稷痔受,谖秀检查罐误霸隽鬟旁 写注释稷麻颓,酃鼹浚费对阏。也洚,在缭写程序的时候,默程序员翡 角度看,一翡都怒邵么涛濒、篱零,~霞了然。瞧是最初编写程序对昀 想法、思路都会随着时潮的掭移耐;薯渐淡寒,从而,某段特定代码在程 序中的特殊用途和厢意t鳆会随辫被遗忘。对任何程序,无论是日后自 己对之进行改进、修改,趱魑交给他人做进一步开发、维护,靠纯粹阅 读代码来理解程序设汁的初寝.以及各部分具体细节绝非易事。注释 的存在此时蜢得肆常的臌瓣。特别鼹当你霈餮别人来阅读自己所写的 代码。否则,程序编写一照崧成,将没有人再能够完整地解释代码的用 途、变量的意义、程序锚构。以殷复杂计算的功能,这条程序也就沦为 不可修改、开发的“死襁序”简被淘汰。 总之,通过注释不仅可以让自霸可以尽快找到程序中需要修改、 完善的地方,也方便篡他人继缝歼发、阅读或使用自己所写的程序。 1.使用“∥”作涟释 虽然,C++能够编译C的潍释,即--x口“胪”和“m,”。在使用注释时 候,大家应该只使用C++风格的注释,即使用“∥”做注释。这可以防止 注释在意外地遇到~个C风格酾漉释缭柬标记“吖”提前结束。 众所周知。C风磷的注群“∥”辩“女,”可避褥一大段、包摄若干行酌 注释,孬£++风格黪注释…//’鲻楚对一纷注释露效。鼹激。在秀为多行 终注释霹,许多耪、中缓稷浮舞郄会贪嚣方便溪霞莲铲”纛“4,”,是骞 耋褚对单行懿骰注释瓣,稔船考使爆“疗”。这静骰法萼溪于势整谡。楚 霜‘守”帮“鬈”辩多行徽注释似乎镤篱侵,餐冀中爨藏羞爨意,莲薅爵蘸 为我翻翦程彦带来意愆不爨翡瓣烦。露始,在爱掰“萨”穗“≮”辑敲麴多 行戆注释器溥孛.麓聚我餐笼意中嗣豫。≯“广、””、“扩、≈”孛茌~字 符{或是在注释段中,霸鼍女”翻“$,”之溺,多麴了一个注释夹“产”或注 释尾“《”;叉鼗楚copy、paste捺律漪钕了毫£没骞意瑷鹫,藤爻对连释 段育影响鹋字符融,熬个鞭侉簸会邋遘不必要的寐矮。茏其是在一拿 程穿两对经凡个入乎豹情况下,遨耱豢故发生酚可悲性就越大。 所以,簧绦诞程序的蜜套、稳定性.建议各位程序员不要怕一对静 麻烦,在为一大毂(蒋干行)文字、代码做注释时,应该坚持在每个注释 行前都使用c++的行注释符‘‘/,”,以瓣兜不必嚣的出错。 如果单行和多行的情况部使用“∥徽没释、那么,在什么时候我们 才应该使用“/丰”和“+/”呢?媾搽,作为C¨襁序员,我们应该尽量摆脱 旧的C语言编程习惯的干扰,使用C¨编稷的风格。所以,任何时候, 我们的C++程序中都不应该使用“胪”和“4/”。 如果真的一定要使用它们。只有柱糨序代码的编写、调试阶段,当 我们暂时不使用一段代码,则可焖“严”羊矸“$/”将之暂耐屏蔽。要记住, 这个注释只是暂时的,一旦究成测试,就请将它立即删除。§u果你还想 将注释的内容作为参考保留。则应淡蔼点对蠲,飚‘W”取我,嵌保证程 序的安全经和连贯性。 2,注释戆传缩簿黢 鳃舞将连爨掇鹫程廖我弱巾}努蕊要。熬慕方法不警,嚣翟不麓 这赘疆蘩效暴,还会蓰姣秀稽趣采蹩潮凌蘸,降德袋褥戆嚣渎挂,事嫠 囊事。要羡善健璐辩霹读憨,必须瀵守一定酌蟪照使弱注释。 蓄先要考虑筏稳鹁帮弱。囊通常荣鼹下,建滋将注释积健霹不薮 在嚣一嚣,茏冀馥鼹注器巍戮代码秘熊对。这黪,注释还翡起蘩蠡瑟跫 穆蘩,逡容溥臻、嚣簿鼹瓣+莠鼠整铃弼鞍注释黪接索互对独立。还要 注意注释魏赣透程囊&Vector) -,throw(std::out_of_range) { ,,初始化Max,如果vector为缀, |}将throuw std::out_of range exception double Max=Vector.at(O); for(int江O;iMax) //如聚第i个元黎 { ∥毙当黥Maximum傻鼹大 Max=Vector[il; //粼将Maximum簸设必 l 髟第i个霓豢的德 return 再看下镄。绘谨萄燕注释稳蕊多余,猩越後游鬯终鸯浚鹗薮登注 释静方法,蠢禚嚣帮遥撵潘锈缭寒鹣太括弧主注释: ;露endif }∥endfor }艘For l//end foffInt i=O;i&Vector) wthrow(std::out_of_range) { double Maximum=Vector.at(0); for(int诘O;iMaximum) { Maximum=Vector[i]; ………………一一∥ } } return Maximum; } 头文件中的注释也同样,如下: double GetMaximutnValue(const std::vector&Vector) -.throw(std::out_of_range) ∥目的:返回存放double类型元素的扁 ∥ 量的当前最大值 ∥要求:vector不为空商量 ,,承诺:此函数将返回当前vector中的 ,/ 最大的元素的值 我们应该记住.在程序中,从界颟的角度而育。头文件通常是唯一 的最新文档,因此,每当代码发生了改变,我们应该及时地维护、更新 相对应的注释对它们进行维护以保持更新。否则,注释很快就会失效。 4.使用注释改善外观 使用注释的作用之一是有助于改善代码在屏幕显示或打印时的 整体外观。 使用注释的主要目的就是对代码作注解,以便改善其可读性。注 释是放在程序代码的适当位霞以便用来注解那些容易引起混乱的代 码。请注意,只有合理地使用注释才能达到这个目的。无计划地乱放注 释,只能影响代码的整齐性、条理性,弄巧成拙,反而降低代码的可读 性。 如何将注释加到程序代码十分重要的。方法不当,会使代码不清 晰。遵循以下凡条原则使用注释,可以改蔷代码的可读性。 曹先,不要打乱代码的布局。注释应该和代码区分开来,如在标题 周围加上边撰、在函数之阍加上一个分黼行等等。以这种方式使用注 释时,千万不要迁代弱被一堆“字符”或其德符号淹没。且应该必须保 持始终如一她这榉做。 还有些编译器。如C++Builder会在它生成的代码模块之阏自动加 入分隔行和缩进。这样具有附加的附代码分隔可以帮助改善代码的外 观fil。这是一个好的方法,我们应该学会在编褪的时候使用此方法。 改善代码的可读性,提高编程效率,还有多种途径。我们将会在以 后探讨。养成规范编程的好习惯,在软件工程起黄重要的作用。单从注 释而言,只要在编程时按本文所述的规则和各种方法去做,并坚持不 懈地使用,就能达到预期的效果。黪 ’融●卜————————————————————~—— 【参考文献】 [1]Hollingworth J.,Butterfield D,Swart B,Allsop J'C++Builder5 Developer’S Guade[M].201 West 103rd St.,Indianapolis,Indiana,USA:SUMS,2000. 《上接第33贾》证明:依攮弓l理l。1:当T。满足n=l,m=k2(k为大 于l的芷整数)时,Ti是整圈。下斌考虑疋,依据(2.1)式和(2.2)式有 矗位)哦n)隅(^)一哦队,,(n≥2珏∈Ⅳ) :(A“-mA“厂‘似”2-2mA“卢A州,…@2嗍厂’溶。一2嘲 若氏(x)--o有整数解,蒯必须有垢”藕-C2甄-m都是整数,显然这 是不可能的,即无论m取任何大予等于2的正整数,T2都不是整图。 依据定理2。l可知 知jx砖Ⅺ。llq—《fJx)知。《x) =疋,mJ 阪。防,一哦。球’)∞≥2站E N)(2.4) 由(2.4)式可知T¨的特征值一定是Tn的特征值,因此1■不是整 图时,Tn也不是整图。 故若Tn为整图,则Tn必为…颗艇,且n=l,m=k2(k为大于l的正 整麴。霞 [责任编辑:张慧] ●卜_——~………~…——— 【参考文献l [1】DouglasB。West著《图论导{{》机械工业出版社2005.1l, {2 lM.Lepovie王Gutman,Some spectral properties of starlike trees,2001。 [3]驮紊云编著《集台论每图论》lE京大学出版社1998。2. (4j左孝凌编《离散数学》上海科学技术出舨裢1990.4. [5]J,A Bondy编(eRAPH THEORY WITH A删CATIONS)1976. 1 6 IR.A.Braldi and H.王Ryser,Combinatorial Matrix TheoD,,Encyclopedia of Mathematles and its Applications,Cambfidqe University Press,Cambridge,UK.1991. 作者简介:卢自娟(1972~),女,克拉玛依职业技术学院基础部讲师,新疆 大学在读研究生。 [责任编辑:张新雷】 万方数据
展开阅读全文
  皮皮文库所有资源均是用户自行上传分享,仅供网友学习交流,未经上传用户书面授权,请勿作他用。
0条评论

还可以输入200字符

暂无评论,赶快抢占沙发吧。

关于本文
本文标题:养成c++编程好习惯提高程序可读性——之注释篇.pdf
链接地址:http://www.ppdoc.com/p-10914238.html
关于我们 - 网站声明 - 网站地图 - 资源地图 - 友情链接 - 网站客服客服 - 联系我们

copyright@ 2008-2018 皮皮文库网站版权所有
经营许可证编号:京ICP备12026657号-3 

收起
展开