欢迎来到XiaoerCMS官网,XiaoerCMS被业界瞩目、与同行友好合作、拥有经验丰富的网站开发技术团队!
不忘初心,方得始终
中高端网站定制开发服务商
与我们取得联系
198-1095-0281 791609988
网站建设资讯 • 网站设计趋势 从品牌网站建设到网络营销策划,从策略到执行的一站式服务

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

发布日期:2022-07-13 15:04:43 热度:
摘要:对齐注释行对于那些在行末写有注释的代码,应该对齐注释行来使得方便阅读有些开发人员使用tab来对齐注释,而另外一些人会用空格来对齐。
网站优化

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


11
本文网址:网站制作中关于代码注释的7个技巧
免责声明:文章《网站制作中关于代码注释的7个技巧》来至网络,文章表达观点不代表本站观点,文章版权属于原作者所有,若有侵权,请联系本站站长处理!

我们立足于合肥面向安徽乃至全国全球市场,我们拥有一支经验丰富、创意独到、团结协作的专业技术团队。我们立志把最好的技术通过最有效、最简单的方式提供给客户,为客户提供最佳的解决方案,我们将通过不懈努力成为客户在信息化领域值得信任、有价值的长期合作伙伴,帮助客户在新经济时代下,把握商机和发展空间,并获得绝对的竞争力!

小二CMS(xiaoercms.com)成立于2013年9月,致力于研发目前国内最专业、功能最强大,扩展性能最自由灵活的高端行业通用的网站系统。目前独立开发的系统包括家装门户网站系统、B2C商城系统、分类信息系统、企业建站系统、O2O家政系统、O2O维修系统、威客系统、国外游戏币交易系统等。我们做的不仅仅是网站系统,更多的是成就您的成功!

关于我们

小二CMS(xiaoercms.com)成立于2013年9月,致力于研发目前国内最专业、功能最强大,扩展性能最自由灵活的高端行业通用的网站系统。目前独立开发的系统包括家装门户网站系统、B2C商城系统、分类信息系统、企业建站系统、O2O家政系统、O2O维修系统、O2O上门服务系统、威客系统、国外游戏币交易系统等。我们做的不仅仅是网站系统,更多的是成就您的成功!

我们的优势

九年建站服务经验
服务3000家企业
资深行业分析策划
前沿视觉设计、研发能力
前端代码深度符合SEO优化
千家成功案例

独家源码出售
具有完备的项目管理
完善的售后服务体系
深厚的网络运营经验
时刻新技术领先研发能力
方便二次开发

我们的不同

我们是一个年轻且富有激情的团队,我们沉迷于代码并陶醉在设计之中。我们非设计,不生活;无兄弟,不编程!可年轻并不意味着没有经验。团队成员均来自各顶尖设计公司及软件公司,我们对网站设计及开发驾轻就熟,有着数百个成功案例。我们坚信用心服务,用实力说话!我们的使命:通过我们的努力,让技术改变命运!我们的宗旨:客户第一,品质至上!我们的信念:唯有客户的成功,才是我们的成功!

城市分站: 合肥 安庆 芜湖 阜阳 淮南 淮北 黄山 蚌埠 马鞍山 铜陵 滁州 宿州 六安 池州 宣城 北京 上海 南京 苏州 东莞 广州 深圳 杭州 天津 济南 太原 成都 沈阳 哈尔滨 长春 大连 三亚