代码规范若干「建议收藏」

代码规范若干

大家好,又见面了,我是全栈君。

1.       JS方法一定要有注释

 代码规范若干「建议收藏」

2.       JS功能要有注释

 代码规范若干「建议收藏」

如上图所示,有注释,几个月后维护,只需1秒就能看懂它的功能,如果没有注释,你需要在代码中查询RESPONSIBLEDEPT或者查找数据库设计文档才能知道这段代码的含义

3.       类一定要有注释

 代码规范若干「建议收藏」

4.       C#代码要用#region包起来,#region之间要留一个且只留一个空行

 代码规范若干「建议收藏」

 代码规范若干「建议收藏」

5.       含义复杂不容易看懂的参数要写注释

 代码规范若干「建议收藏」

6.       方法参数注释,如果不写请删掉

 代码规范若干「建议收藏」

7.       类的成员变量名以m_开头

 代码规范若干「建议收藏」

 代码规范若干「建议收藏」

8.       DAL或Service变量名:m_类名

 代码规范若干「建议收藏」

9.       DAL层代码规范:向DAL类中添加方法,应根据方法的语义和方法的返回值决定方法写在哪个DAL类中

代码规范若干「建议收藏」

 张三需要一个根据员工编号获取员工信息的方法,他把这个方法写在了ReportDAL类中,并起名GetEmployee(string empCode),李四也需要一个根据员工编号获取员工信息的方法,他去EmployeeDAL中去找这个方法,没有找到,或者他压根没有去找,李四在ReportFlow中写了一个GetEmployeeByCode(string empCode)方法,随着开发的进行,代码会变得相当混乱。王二需要修改BUG,发现需要修改GetEmployee(string empCode)方法,他修改了这个方法,但并没有把BUG修改掉,因为他不知道在某个地方还有个GetEmployeeByCode(string empCode)需要修改,一个简单的BUG就这样变得复杂起来

   

转载于:https://www.cnblogs.com/s0611163/p/6023476.html

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/108805.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)
blank

相关推荐

  • java数组拼接

    java数组拼接JAVA数组拼接(扩容)int[]A=newint[]{1,3,5,7,9};int[]B=newint[]{2,4,6,8,10};arrayJoin(A,B);}publicstaticvoidarrayJoin(int[]a,int[]b){int[]arr=newint[a.l…

  • 有没有提醒喝水的打卡软件_小爱同学定时打卡

    有没有提醒喝水的打卡软件_小爱同学定时打卡本文方案来自CSDN博主「机灵鹤」方案详情可查看原文:https://smartcrane.blog.csdn.net/article/details/121837850本项目实现了一个久坐提醒和喝水提醒的小助手,在检测到连续工作较长时间之后,会打印纸条,提醒我们起身活动一下;在设定的喝水时间到了以后,也会打印纸条,提醒我们去喝水。项目用到的硬件设备有:硬件都备的差不多了,在开发时我遇到了一个比较棘手的问题,就是咕咕机跟人体传感器它也不是同一家的设备啊!虽然两家都有各自的控制APP,但是它们毕竟是两套系

  • 怎么快速拿到跨境电商ERP源码?[通俗易懂]

    怎么快速拿到跨境电商ERP源码?[通俗易懂]回顾全球跨境电商行业发展历程可以发现,跨境电商是从传统外贸发展到外贸电商,在进一步发展成为跨境电商的,跨境电商发展至今,也不过二三十年的时间,借助于互联网技术的快速提升,跨境电商呈现出爆发式增长。我国跨境电商在二十年间从无到有、从弱到强,经历了从萌芽到成长、从扩张到成熟的四个阶段。当前,我国跨境电商产业正在加速外贸创新发展进程,已经成为我国外贸发展的新引擎。客乐乐ERP是一款专业的跨境店铺管理ERP软件,由顶级技术团队打造,致力于帮助跨境卖家增效降本、提高效率1.订单管理自动审单、标记发货

  • prototype.js教程及prototype中文手册

    prototype.js教程及prototype中文手册http://topmanopensource.iteye.com/blog/382425收集了网上的prototype.js教程及prototype中文手册,方便大家使用prototype.js1.4中文教程doc格式http://www.dayanmei.com/upload/prototype1.4.docprototype.js1.4中文教程以及prototype1.5英文教程以及p…

  • 强对偶性、弱对偶性以及KKT条件的证明(对偶问题的几何证明)[通俗易懂]

    强对偶性、弱对偶性以及KKT条件的证明(对偶问题的几何证明)[通俗易懂]本文主要探讨优化问题中强、弱对偶性以及KKT条件的证明。

    2022年10月13日
  • VC中获取窗体句柄的各种方法

    VC中获取窗体句柄的各种方法

    2021年12月10日

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号