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

代码规范若干

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

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)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • 仿ios版微信应用源代码[通俗易懂]

    仿ios版微信应用源代码

    2022年1月23日
    139
  • sbc音频编解码是什么_编解码算法工程师

    sbc音频编解码是什么_编解码算法工程师转自:https://blog.csdn.net/wzz4420381/article/details/48676921原作者:wzz4420381 1.SBC算法简介SBC是subbandcode的缩写,也可称为子带编码 在A2DP协议中,SBC算法是默认支持的 蓝牙SBC算法是一种以中等比特率传递高质量音频数据的低计算复杂度的音频编码算法1.1算法基本框图SB…

    2025年10月26日
    3
  • 新出台的治理iMessage垃圾短信的规则

    新出台的治理iMessage垃圾短信的规则

    2022年1月21日
    65
  • 关于我对stm32看门狗的一些理解(基于正点原子)

    关于我对stm32看门狗的一些理解(基于正点原子)咕咕咕之后想更会儿stm32哈哈哈,但是其实是之前自己写的笔记,想着以后就写在一起吧,我自己也更好去找到自己写的玩意~毕竟总所周知,博客都是写给自己的。(虽然好像现在自己都看不懂了我的天哪)一.什么是看门狗在stm32中,我们会学到独立看门狗和窗口看门狗的实验。第一眼肯定是一脸懵逼啊,啥是看门狗啊?看门狗在日常生活中,大概的印象就是,起到一个保证安全,防止外来人员搞事的作用。stm32中的看门狗也起着差不多的意思:看门狗就是起到一个监督单片机是否正在正常运行的作用。如果程序运行异常(跑飞),那么

    2022年5月13日
    68
  • Navicat 连接 MySQL「建议收藏」

    Navicat 连接 MySQL「建议收藏」简述Navicat是一套快速、可靠和全面的数据库管理工具,专门用于简化数据库管理和降低管理成本。Navicat图形界面直观,提供简便的管理方法,设计和操作MySQL、MariaDB、SQLServer、Oracle、PostgreSQL和SQLite的数据。在使用Navicat远程连接MySQL数据库时,经常会出现一些错误,今天我们来分享一下经验。|版权声明:一…

    2025年6月11日
    4
  • 二代身份证号码验证器[超简单]

    二代身份证号码验证器[超简单]一代身份证号码是十五位,2013年1月1日开始,咱们中国全面停止使用一代身份证了。二代身份证号码:1-6位:表示行政区划的代码。 1、2位,所在省(直辖市,自治区)代码; 3、4位,所在地级市(自治州)代码; 5、6位,所在区(县,自治县,县级市)的代码; 7-14位:表示出生年、月、日 15-16位:所在地派出所代码 17位:性别。奇数(1、3、5、7、9)男性,偶数(2、4、6、8、0)女性 18位:校验位,存在十一个值:0,1,2,3,4,5,6,7,8,9,X,..

    2022年6月27日
    59

发表回复

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

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