网站建设

网站建设

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

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

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

相关新闻推荐

网站制作多少钱算合理?三个价位对应三种做法

网站制作多少钱算合理,这问题没人能张口就给答案,因为合理的标准取决于你要什么。不过把这些年的行情归归类,大致能分成三档,每一档对应的做法和效果都不一样,你可以先对号入座。第一档,几千块钱。这个价位能做出来的,多数是套用现成模板,选一套风格接近的,换上你的、图片和文字。适合刚起步的公司,先把门面撑起来,客户搜到你的时候能有个正经页面看。这一档得认清一点:便宜的网站制作意味着你的页面跟别人撞脸的概率不...

2026-09-10

网站设计为什么看着都差不多?问题出在这一步

做这行久了,经常有人发我一个链接说:你看这家网站设计得多好,我们也照这个样子来。打开一看,果然是眼熟的那套:顶部大轮播、三栏产品展示、蓝色主色调,跟旁边几家同行像一个模子刻出来的。网站设计为什么看着都差不多?多数时候不是设计师偷懒,而是从最开始那一步方向就偏了。第一个原因,是照着同行抄。很多人动手前先做一件事:把同行的网站存一遍,挑个顺眼的当模板。抄结构、抄版式、抄配色,抄到最后,客户分不清谁是谁...

2026-09-10

网站制作中的字体版权问题,别等被投诉才知道

网站上线没两天,邮箱里躺着封律师函,说你页面用的字体侵权,要求赔偿几万块这不是段子,是这些年越来越多企业真实碰到的事。字体版权这东西,大多数人压根没概念,觉得字不就是字吗,还能有版权?可等被找上门,就晚了。网站制作这道工序里,字体版权恰恰是最容易被忽略、又最容易踩雷的一环。先把道理说透。你电脑里、系统里自带的那些字体,是给你个人日常使用的,不代表能拿来做商业用途。像方正、汉仪、造字工房这些字库公司...

2026-09-07

企业官网网站制作,需要准备哪些资料?

很多人第一次做官网,被建站公司一问资料准备了吗,当场就懵了。其实要准备的东西没多复杂,只是没人提前跟你说清楚,才显得手忙脚乱。梦扬科技按顺序捋一遍,你照单子收拾就行。先说公司基础资料。营业执照是最基本的,做网站备案、签合同、开通线上支付都会用到,扫描件存一份高清的。然后是公司,最好是矢量格式的源文件,别给一张糊糊的截图,不然设计师放大就会失真。再有就是公司简介和联系方式,电话、邮箱、地址、地图定位...

2026-09-07

都2026年了,企业现在还有必要建官网吗?

先说结论:企业依然非常有必要建官网,但不能只做一个静态摆设官网。当下抖音、小红书、美团、1688、视频号等平台流量再火,也无法替代独立官网的核心价值。平台只是流量渠道,官网是企业完全自主可控的线上总部、信任底座、长期资产,二者是互补关系,而非二选一。下面梦扬科技说下官网不可替代的7个核心价值和3个误区核心价值一:完全自主可控,不受平台规则拿捏。所有第三方平台都有致命短板:算法限流、封号、规则改动、...

2026-09-06

从域名到上线:企业网站建设的完整流程

不少企业第一次做网站,对整个流程没概念,以为就是把页面做好、传到网上就完事。真到自己走一遍才发现,从域名到上线,中间的环节一个不少,每一步都有讲究。今天梦扬科技就把企业网站建设的完整流程从头到尾捋一遍,心里有谱了,跟建站方沟通的时候也不至于稀里糊涂、被人牵着走。第一步,定域名。域名是网站的门牌号,最好跟公司名或品牌沾边,短一点、好记一点,方便客户搜索和口口相传。注册要选正规服务商,后缀、续费价格、...

2026-09-02

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

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