网站建设

网站建设

了解最新的网站建设动态、行业资讯和技术分享

网站制作中关于代码注释的7个技巧

2017-05-11 网站建设 3987 次阅读
1. 对齐注释行
对于那些在行末写有注释的代码,应该对齐注释行来使得方便阅读
有些开发人员使用tab来对齐注释,而另外一些人会用空格来对齐。由于tab在不同的编辑器和集成开发环境中会有所不同,所以最佳的方法是使用空格来对齐注释行。
2. 使用统一的风格
有些人觉得注释应该让非程序员也能看懂。另外一些人觉得注释需要面对的读者只是程序员。无论如何,正如Successful Strategies for Commenting Code中所说的,最重要的是注释的风格需要统一,并且总是面向相同的读者。就自己而论,我怀疑非程序员是否会去读代码,所以我觉得注释应该面向程序员来写。
3. 对不同级别的代码进行注释
对于不同级别的代码块,要使用统一的方法来进行注释。例如:
对于每一个类,需要包含一段简明扼要的描述,作者和上一次修改的时间
对于每一个方法,需要包含这个方法的用途,功能,参数以及返回结果
当你在一个团队里面的时候,采用一套注释的标准是非常重要的。当然,使用一种大家都认可的注释约定和工具(例如C#的XML注释和Java的Javadoc)在一定程度上能推动这项任务。
4. 使用段落注释
首先把代码块分解成多个“段落”,每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释,告诉阅读代码的人接下来的这段代码是干什么用的
5. 不要侮辱阅读者的智慧
这不单把时间浪费在写没用的注释上面,同时也在分散读者的注意力。
6. 直截了当
不要在注释里面写过多的废话。避免在注释里面卖弄ASCII艺术,写笑话,作诗和过于冗长。简而言之就是保持注释的简单和直接。

相关新闻推荐

网站开发一站式服务 企业官网定制搭建

网站开发不用东奔西跑找多家团队对接,现在最受企业欢迎的,就是省心省力的网站开发一站式服务,从前期需求沟通、官网定制设计,到后期开发搭建、测试上线,再到售后维护,全程由一个专业团队全包搞定,企业不用懂技术、不用花时间协调,只需要配合提供基础资料,就能轻松拥有一套贴合自身业务、颜值在线、稳定好用的专属企业官网。很多企业老板以前做网站,都有过头疼的经历:找设计公司做页面,找开发团队写程序,找第三方做备案...

2026-05-19

靠谱网站制作公司 专业企业官网定制全包

网站制作找对公司,能少走90的弯路、省下大把时间和预算,而一家靠谱的网站制作公司,核心优势就是能提供专业企业官网定制全包服务,从前期需求沟通、方案策划、设计制作,到后期开发测试、上线备案、售后维护,全程一站式搞定,企业不用多头对接、不用懂任何技术,只需要配合提供基础资料,就能轻松拥有一套贴合业务、稳定好用的专属企业官网。很多企业老板在建站时都有过踩坑经历,要么找低价小作坊,看似便宜,实则偷工减料、...

2026-05-19

快速迭代网站开发,支持后期功能持续升级优化

网站开发不用一味追求一步到位花大价钱做满所有功能,真正适合企业长期经营的做法,就是做快速迭代网站开发,先把基础版网站快速落地上线用起来,再根据生意发展节奏支持后期功能持续升级优化,网站跟着业务一步步成长,不花冤枉钱、不做无用投入,实用又灵活。很多企业在建站初期最容易犯的错,就是总想一次性把所有想到的功能全部做完,不管当下用不用得上,全都堆在网站里,不仅建站成本居高不下,网站结构还做得臃肿复杂,后台...

2026-05-18

高端品牌网站开发,兼顾视觉设计与技术性能

网站开发想要真正撑起企业品牌形象,打造有质感、有调性、有实力的线上门面,一定要做专业的高端品牌网站开发,不只追求表面好看的视觉效果,更要扎实做好底层技术性能优化,做到颜值气质和使用体验两手兼顾,让网站看着高端上档次,用着稳定又流畅。很多企业做品牌网站容易陷入两个极端,要么一味堆砌炫酷特效、华丽画面,看着第一眼很惊艳,实际打开加载慢、手机端卡顿、运行不稳定,客户耐心耗尽直接关掉;要么只重视技术稳定,...

2026-05-18

中小企业网站开发,低成本实现高质量上线效果

网站开发对于大多数中小企业来说,不需要动辄花费高额预算做复杂花哨的大平台,真正务实靠谱的选择就是做好贴合自身需求的中小企业网站开发,花不多的钱、走实在流程,低成本就能做出专业大气、稳定好用、符合企业形象的高质量上线效果,不花冤枉钱、不踩建站套路,让小企业也能拥有大品牌一样的正规线上门面。很多中小企业老板心里都清楚,自己做网站的需求很简单,无非就是线上有个官方展示名片,客户搜得到、看得懂、信得过,能...

2026-05-16

定制化网站开发,根据业务逻辑实现专属功能模块

定制化网站开发不靠现成模板凑数、不按固定套路搭建,而是完全按照企业自身真实业务逻辑,量身打造贴合经营模式的专属功能模块,需要什么就做什么,用不上的一概不瞎加,让网站适配你的生意流程,而不是让企业硬去迁就网站的死板规则。很多企业做网站踩坑的根本原因,就是一味选用千站一面的通用模板站,外表看着干净整洁,内里功能全是固定死的标配,不管你的业务是做工程接单、招商加盟、批发供货、会员锁客,还是项目预约、在线...

2026-05-16

准备好开始您的项目了吗?

立即联系我们,获取专业的网站建设方案,让您的品牌在数字世界中脱颖而出