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

代码规范若干

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

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

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

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

赞 (0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • layui弹窗间的传值(layui弹出层传值)(窗口传值)[通俗易懂]

    layui弹窗间的传值(layui弹出层传值)(窗口传值)[通俗易懂]主要有两部分1、从主窗口传值到弹出层2、从弹出层传值到主窗口1、从主窗口传值到弹出层首先时jschangefileone函数时按钮绑定事件,按钮点击后调用这个函数然后弹出弹出层,加载changefile.html界面然后success提前加载changefile的form数据(从主窗口传值到弹出层)//bootstraptable的修改,点击按钮的时候自动选中该行,因此可以获取到整行…

    2022年6月12日
  • mac avicate15 获取码兑换激活码_最新在线免费激活

    (mac avicate15 获取码兑换激活码)2021最新分享一个能用的的激活码出来,希望能帮到需要激活的朋友。目前这个是能用的,但是用的人多了之后也会失效,会不定时更新的,大家持续关注此网站~https://javaforall.net/100143.htmlIntelliJ2021最新激活注册码,破解教程可免费永久激活,亲测有效,上面是详细链接哦~40…

    2022年4月2日
  • windows tasklist不能用

    windows tasklist不能用我的方法是在cmd下切换到C:\Windows\System32目录下,然后再tasklist

    2022年5月3日
  • 用西尔特编程器解密芯片_配方法解一元二次方程

    用西尔特编程器解密芯片_配方法解一元二次方程z3-solver是由MicrosoftResearch(微软)开发的SMT求解器,它用于检查逻辑表达式的可满足性,可以找到一组约束中的其中一个可行解,缺点是无法找出所有的可行解(对于规划求解问题可以是scipy)。z3-solver可应用于软/硬件的验证与测试、约束求解、混合系统的分析、安全、生物,以及几何求解等问题。Z3主要由C++开发,提供了.NET、C、C++、Java、Python等语言调用接口,下面以python接口展开讲解。……

    2022年10月13日
  • vbs整人小代码大全

    事前准备:创建一个文件夹,后缀名为vbs,在里面编东西即可参考很多资料,如有不足请谅解文章目录vbs整人代码大全1.循环类1.1.一直说Youarefoolish!1.2.打开无数个计算器(慎用)1.3.重复说话100次1.4.不是循环但是很烦人1.5.给我按100次回车1.6.非常恶心的Alt+F42.问答类2.1.简单问答2.2.简单问答2.3.恐怖问答3.威胁类3.1.挟持回答3.2.挟持回答3.3虚惊一场结束vbs的代码完结vbs整人代码大全1.循环类1.1.一直说Youaref

    2022年4月7日
  • 【机器学习】NMF(非负矩阵分解)

    【机器学习】NMF(非负矩阵分解)写在篇前  本篇文章主要介绍NMF算法原理以及使用sklearn中的封装方法实现该算法,最重要的是理解要NMF矩阵分解的实际意义,将其运用到自己的数据分析中!理论概述  NMF(Non-negativematrixfactorization),即对于任意给定的一个非负矩阵V,其能够寻找到一个非负矩阵W和一个非负矩阵H,满足条件V=W*H,从而将一个非负的矩阵分解为左右两个非负矩阵的乘积。…

    2022年6月16日

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

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