网站建设

网站建设

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

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

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

相关新闻推荐

低成本合肥网站建设落地流程,快速上线全套资料清单

很多合肥中小商家、初创公司想做官网,最大的顾虑无非两点:一是怕花钱多、性价比低,二是怕流程复杂、耗时太久,折腾一两个月还没法正常上线。其实对于普通企业展示、产品宣传、基础获客类网站,根本不用搞复杂的定制开发,掌握一套低成本落地流程,备好全套资料,一周内就能完成从筹备到正式上线的全过程。我深耕合肥网站建设行业多年,专门整理了一套适配本地小微企业的轻量化落地方案,全程无冗余步骤、无隐形消费,新手也能直...

2026-07-27

做一个营销型网站建设需要准备什么资料?

有些打算做线上推广的企业,前期咨询网站建设时,都不清楚要提前备好哪些材料,临到开工才到处找素材,直接拖慢整个网站制作周期,还容易反复修改耽误上线进度。营销型网站和普通展示站不一样,核心目的是引流获客,前期资料准备得越齐全,网站开发出来的转化效果也会更好,今天就梳理下搭建这类站点要提前整理好的全部内容。首先是企业基础资质类材料,这是网站上线备案必不可少的。营业执照清晰照片、法人身份证正反面,要是公司...

2026-07-21

短期快速上线项目,合肥网站制作最简内容清单整理

针对企业短期加急、快速上线的合肥网站制作项目,核心原则是:砍掉非必要功能、保留搜索引擎收录与客户转化必备内容、页面结构极简、资料零冗余。避免因内容繁杂、资料迟迟不齐导致工期延期,同时保证网站合规可上线、可收录、可转化,适配初创企业、项目加急、临时品牌展示、业务引流等快速建站场景。以下为可直接对接梦扬科技建站团队的最简标准化内容清单,无需额外补充冗余素材。一、网站基础必备资料(上线硬性要求,缺一不可...

2026-07-21

制造业官网网站开发:产品展示系统独立后台搭建

不少工厂老板在做线上宣传时,踩过不少坑,随便做个普通企业站,产品更新还要每次找建站公司修改,一来一回耽误好几天,客户想看新款设备根本看不到。做制造业官网网站开发,产品展示系统一定要搭配独立后台,自己就能随时操作,不用事事依赖技术人员,对生产型企业来说实用性很高。普通展示网站的产品板块大多是固定页面,后台权限有限,增删设备、更换参数、上传实拍图都操作不了。而专门为工厂定制的独立产品后台,权限完全掌握...

2026-07-17

网站制作忽略移动端适配,会流失大半手机端客户吗?

现在大家不管是找服务、查商家还是咨询合作,基本都是拿着手机操作,真正坐在电脑前浏览网站的人少之又少,做网站制作时要是完全不管移动端适配,流失大半手机客户真的不是危言耸听。先说说最直观的用户体验问题。没有适配手机的网站,在手机上打开只会把电脑页面直接缩小,文字挤成一团,字体小到看不清,想放大页面,侧边栏、弹窗又会到处乱跑,点个咨询按钮、联系方式都很难精准触达。很多人打开网页三秒内看不到有效信息,手指...

2026-07-17

初创公司预算有限,网站建设选模板还是全定制?

不少刚起步的初创企业在规划线上门面时都会陷入纠结:手里可支配推广、建站预算不多,想拥有能承接客户、展示业务的官网,却不知道该选模板网站,还是直接做全定制网站。很多人第一反应是模板建站省钱省事,可综合长期运营、转化效果来看,即便预算紧张,初创公司优先选择全定制网站建设,才是更划算、更适配长期发展的选择。先说说模板网站的底层短板,这也是它看似低价,实则暗藏隐性成本的核心原因。模板网站是批量预制的标准化...

2026-07-14

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

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