18326051278
2018-12-07
毅耘科技
5902
合肥毅耘科技：app开发的6个注释技巧
对于公司，好的注释以利于代码的维护，毕竟写的代码后面或许是一个程序员或者多个程序员在维护，如果代码注释风格或者注释非常混乱，那么后面的程序员在接手的代码时候，维护非常困难，毅耘科技表明一般的代码注释，都是依据某种规范来进行的。关于不一样等级的代码块，要运用统一的办法来进行注释。
1. 对不一样等级的代码进行注释
关于不一样等级的代码块，要运用统一的办法来进行注释。例如：
关于每一个类，需求包括一段短小精悍的描述，作者和上一次批改的时间
关于每一个办法，需求包括这个办法的用途，功用，参数以及回来成果当你在一个团队里边的时分，选用一套注释的规范是非常重要的。当然，运用一种我们都认可的注释约好和东西(例如C#的XML注释和Java的Javadoc)在必定程度上能推进这项使命。
2. 运用阶段注释
首先把代码块分解成多个“阶段”，每一个阶段都履行单一的使命;然后在每一个“阶段”开端之前增加注释，通知阅览代码的人接下来的这段代码是干什么用的
3. 对齐注释行
关于那些在行末写有注释的代码，应当对齐注释行来使得便利阅览
有些开发人员运用tab来对齐注释，而别的一些人会用空格来对齐。因为tab在不一样的编辑器和集成开发环境中会有所不一样，所以最好的办法是运用空格来对齐注释行。
4. 不要凌辱阅览者的才智
要防止没用的注释，例如这不单把时间糟蹋在写没用的注释上面，一起也在涣散读者的注意力。
5. 要有礼貌
应当防止没有礼貌的注释，例如“要注意一些愚笨的用户会输入一个负数”，或许“批改由菜鸟工程师写的愚笨得不幸的代码而致使的副作用”。这样的注释关于代码的写注释的人来说并没有任何好处，一起你永远都不会知道将来这些注释会被谁来阅览，你的老板，一个客户或许是方才被你数说的愚笨得不幸的工程师。
6. 开门见山
不要在注释里边写过多的废话。防止在注释里边做作ASCII艺术，写笑话，作诗和过于冗长。简而言之即是保持注释的简略和直接。
合肥专业APP制作--毅耘科技，欢迎关注安徽毅耘科技有限公司：http://www.yiyuncloud.com
本文标题：合肥毅耘科技：app开发的6个注释技巧
本文网址：http://www.yiyuncloud.com/index/id/2486.html
原创网址：合肥APP开发公司<毅耘科技> 版权所有，转载标明出去，并以链接形式链接网址：www.yiyuncloud.com
文章标签：合肥APP开发 合肥软件开发 合肥o2o社区 合肥商城开发 合肥B2B2C商城开发
毅耘科技（www.yiyuncloud.com）是一家拥有新型网站建设与程序开发经验的公司，致力于解决企业网络服务问题，紧跟着网络变化的步伐，为企业提供网络科技服务。平台服务：品牌网站建设 、网站开发、微信开发、APP开发、软件开发、网校系统开发、多用户商城开发、分销商城开发、微商城、一元云购系统开发、O2O系统开发、商标注册、网络营销等项目。是专业为企业提升价值的公司。
导航
返回列表
在线咨询