代码规范：规范你我他
学习代码规范的目的：
为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护。
因为软件是需要人来维护的，这个人在未来很可能不是你。所以首先是为人编写程序，要让大家可以一眼看懂你写的是什么，简洁的代码更容易看出bug，让bug无处躲藏。
为什么要规范代码：
第一：统一性，有助于团队的合作
第二：减低维护成本
第三：简洁，简洁的代码更好凸显出BUG
第四：养成良好的习惯，帮助自己成长。
注释规范：
对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：
/*************************************************作者：小组： 说明：创建日期：版本号：**********************************************/在模块、类、属性、方法前一行添加注释，以便调用的时候提示用户
下以方法声明做例子：
/// <summary>/// depiction：<对该方法的说明>/// </summary>/// <param name="<参数名称>"><参数说明></param>/// <returns>///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>/// </returns>命名规则：
名字应该能够标识事物的特性，并且与业务挂钩。
名字一律使用英文单词，而不能为拼音。
名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。
在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。
数据库命名规则：
数据库名采用首字母大写，避免系统保留的表名。如：LibraryMaintainSystem
代码规范：规范你我他相关推荐
- PHP PSR-2 代码风格规范 (中文版)
代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目中合 ...
- 代码管理规范_微服务架构下代码管理规范
当下对于代码的管理,主要采用GitLab或GitHub,然而使用git进行代码管理过程中,一般有四种开发模式,分别为主干开发主干发布,主干开发分支发布,分支开发主干发布,分支开发分支发布.四种开发模式 ...
- eclipse java代码某一行需要修改注释_看看这些Java代码开发规范吧！你好，我好，大家好！...
作为一名开发人员,当你接手他人的项目时,且当你阅读他人的代码时,是有没有遇到脑袋充血,感觉Java要把你"送走"的感觉呢?我们在用Java开发技术进行开发前,一定要牢牢恪守Java ...
- html空格代码_编写灵活、稳定、高质量的CSS代码的规范（推荐收藏）
01 编写灵活.稳定.高质量的HTML代码的规范 一.唯一定律 无论有多少人共同参与同一项目,一定要确保每一行代码都像是唯一个人编写的. 二.HTML 2.1 语法 (1)用两个空格来代替制表符(ta ...
- PHP中类和文件的代码注释规范
编写好的文档对于任何软件项目都至关重要,不仅是因为文档的质量可能比代码的质量更重要,还因为良好的第一印象会促使开发人员进一步查看代码以及后续的迭代. 文件注释 /*** Sample file com ...
- java 注释 超链接_java_Java代码注释规范详解，代码附有注释对程序开发者来 - phpStudy...
Java代码注释规范详解 代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一 在整个应 ...
- Python 工具链让你写的代码更规范
从以前一个不会敲 Python 代码的小白,到现在敲 Python 代码贼溜的老鸟的过程中,除了通过大量的学习.实践让自己现在更容易写出 Pythonic 的代码外,大部分时间里还是多亏着有着许多好用 ...
- .NET代码编写规范 整理
.NET代码编写规范 - [ASP.NET] 2009-02-26 | Tag: 版权声明:转载时请以超链接形式标明文章原始出处和作者信息及本声明 http://lenspe.blogbus.com/ ...
- 程序详细设计之代码编写规范_我在不编写任何代码的情况下建立了一个设计策划网站
程序详细设计之代码编写规范 It's been just over a month since MakeStuffUp.Info - my first solo project as an indep ...
- 从 vue3 和 vite 源码中，我学到了一行代码统一规范团队包管理器的神器
1. 前言 大家好,我是若川.最近组织了源码共读活动,感兴趣的可以加我微信 ruochuan12 参与,每周大家一起学习200行左右的源码,共同进步.已进行四个月了,很多小伙伴表示收获颇丰. 想学源码 ...
最新文章
- nginx产生【413 request entity too large】错误的原因与解决方法
- 加了try的情况下线程中抛出未捕获的异常
- JNDI学习总结（1）——JNDI入门简介
- sm4 的s盒_SM4国密算法Java版
- kafka topic 目录存放在哪_Kafka系列文章之安装测试-第2篇
- Android应用程序管理系列(四)—— packagemanager flags 与 packageInfo
- m1 MacBook Air安装原生版本Emacs之方法
- 国庆档电影《我和我的祖国》3天票房破10亿
- LoadRunner第一次压测实践后的心得体会 收获
- 销售管理系统er图_这套电商订单管理系统，90%电商玩家都受用
- .大道至简之二：如何准确把握趋势
- 内部版本号android,分享个老教程：修改手机型号、品牌、内部版本号、Android版本...
- USB设备导致xp系统蓝屏
- vue 有关于命名大小写的问题
- Chrome 开发者工具 Initiator 面板单击后看不到 JavaScript 源代码的解决方法
- （《机器学习》完整版系列）第5章 神经网络——5.2 RBF网络（单层RBF就可解决异或问题）与ART网络（实现“自适应谐振”）
- 【红宝书笔记精简版】第十二章 BOM
- 美国大学生数学建模竞赛经验心得
- 【docker-jenkins搭建】docker的jenkins容器java版本(四)
- Cannot run program /Library/Java/JavaVirtualMachines/jdk1.7.0_79.jdk/Contents/Home/bin/java