网站建设

网站建设

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

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

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

相关新闻推荐

合肥正规网站建设|备案全包 安全防护 售后有保障

在合肥做实体生意、开小微企业的朋友,大概率都踩过网站建设的坑。我身边不下十个老板,当初图便宜找小作坊建站,最后全都头疼不已:要么做完才知道要自己跑备案,来回跑腿半个多月;要么网站上线没多久就被黑客挂垃圾外链、页面篡改;更离谱的是付完尾款直接失联,网站出问题没人修。踩过这些坑才明白,合肥本地做网站,便宜从来不是第一位,正规、省心、兜底才是刚需。先说所有人最头疼的网站备案问题,这也是绝大多数非正规建站...

2026-06-15

定制化网站制作公司,功能量身开发 满足行业专属需求

接触过不少中小企业老板,聊建站这件事,十个人里有八个都踩过模板站的坑。当初贪图便宜、上线快,花两三千做了一套通用模板网站,上线之后才发现处处别扭:建材行业没法上传工程案例图集、教育培训做不了线上试听预约、商贸企业没有经销商分级查询功能。想改功能被告知模板底层代码锁死,根本没法二次修改,最后只能闲置重做,白白浪费时间和资金。这也是现在越来越多企业放弃模板,选择定制化网站制作的核心原因。不同行业的网站...

2026-06-15

响应式网站制作公司|电脑手机自适应 全网同步展示

现在大伙上网,早就不只用电脑了,手机、平板来回切换是常事。可不少企业的老网站,手机上打开要么字小得看不清,要么排版乱成一团,客户看两眼就直接关掉,白白丢了好多生意。这时候找一家专业的响应式网站制作公司,做个电脑手机自适应的网站,就成了很多企业的刚需。今天梦扬科技就跟大家唠唠,为啥要做响应式网站。先说说啥是响应式网站,说白了就是一套网站,能自动适配所有设备。不管客户用27寸的电脑显示器,还是6寸的手...

2026-06-14

旧网站开发改版 官网升级优化 保留原有权重

经营时间久一点的企业,基本都遇到过老网站跟不上发展的难题。页面样式老旧、打开速度慢、手机端显示混乱,功能也满足不了现在的使用需求,想重新做网站,又最怕一个问题:辛辛苦苦积累多年的搜索排名、流量和权重全部丢失。所以如今很多企业做网站开发,不再是简单推倒重来,而是选择对旧网站进行改版升级,在优化体验的同时,稳稳保住原有权重,这也是目前最稳妥的做法。不少朋友一开始没想周全,直接舍弃老站搭建新站,结果上线...

2026-06-14

合肥中小型网站建设|低成本建站 稳定安全易维护

在合肥做中小企业,想建官网又怕花钱多、怕不稳、怕后期麻烦,这是我每天都能听到的真心话。毕竟合肥房租、人工成本高,中小企业预算本来就紧,大家要的从来不是花里胡哨的功能,而是低成本建站、稳定安全易维护的实用官网,能正常展示业务、方便客户联系、平时不用专人操心,就够了。先说说合肥中小型网站建设的普遍现状:很多老板一开始图便宜,找个人或小作坊做模板站,报价低到离谱,结果踩坑率特别高。要么是网站看着粗糙,和...

2026-06-11

专业网站建设,助力品牌线上形象升级

如今线上传播早已渗透到各行各业,不管是深耕多年的老牌企业,还是稳步发展的新兴商家,品牌形象都不再只靠线下门店、实体产品来支撑。很多潜在客户、合作方第一次了解一家企业,都是从网络开始的,而官网,就是品牌面向全网的第一扇窗口。不少人误以为做网站只是简单搭个页面、放些图文就行,可实际上,一个粗糙敷衍的站点,会悄悄拉低品牌档次;唯有用心打造的专业网站,才能真正完成品牌线上形象的全面升级,为企业发展赋能。在...

2026-06-11

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

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