代码编写规范

逃离我推掉我的手 2021-09-23 15:12 499阅读 0赞

## **一、目的** ##

为了更好的提高工作效率，保证开发的有效性和合理性，并可最大程度的提高程序代码的可读性和可重复利用性，便于交流和维护。

## **二、命名总体规范** ##

*  名字应该能够标识事物的特性，并且与业务挂钩。
 *  名字一律使用英文单词，而不能为拼音。
 *  名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。
 *  在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。

### **比较流行的命名方法** ###

*  Pascal命名法（大驼峰法）：所有单词的首字母都大写，其他字母小写。例如MyFirstName
 *  Camel命名法（小驼峰法）：除首字母外，其他单词的首字母大写，其他字母小写。例如myFirstName

### **参数** ###

*  参数名称使用Camel大小写批注\[梦10\]:
 *  参数名称可缩写

### **方法** ###

*  以动词开头。批注\[梦11\]:
 *  使用Pascal大小写。
 *  禁止缩写，除非名词本身含有缩写。如：AddStudentMgr()

### 属性(property) ###

*  以名词或形容词命名。批注\[梦12\]:
 *  使用Pascal大小写。
 *  禁止缩写

### **事件** ###

*  使用Pascal大小写。
 *  禁止缩写。
 *  名称命名使用Event后缀。
 *  用动词或名词命名，带有时间意义，如：MouseMove事件、Closing事件、Closed事件。
 *  指定两个名为sender和e的参数。sender参数表示引发事件的对象。e为事件类的实例。e参数类型使用适当而特定的事件类。
 *  用EventArgs后缀命名事件参数类。

### **注释** ###

*  在模块、类、属性、方法前一行添加注释，以便调用的时候提示用户
 *  代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法、循环条件、不同分支的意义等等）。

### **缩进规则** ###

*  使用一个“Tab”为每层次缩进（默认4个空格，有的规范也要求2个空格，依要求而定所有IDE都可以设置）。

## **结语：编写代码的规范一定要注释起来，与人方便与己方便，合作共赢，共创辉煌。** ##

发表评论取消回复

表情：

评论列表（有 0 条评论，499人围观）

还没有评论，来说两句吧...

相关阅读

相关代码规范问题：如何编写符合Java Bean规范的类

Java Bean（Java Bean Pattern）是Java中一种常见的对象模型，它遵循一定的规范。以下是编写符合Java Bean规范的类的一些步骤： 1. **命名

待我称王封你为后i/ 2024年10月14日 15:36/ 0 赞/ 72 阅读

相关代码规范：如何遵循Java最佳实践编写代码？

遵循Java最佳实践可以帮助你编写更清晰、更可维护的代码。以下是一些主要的最佳实践： 1. **命名约定**： - 类名首字母大写，驼峰命名。 - 变量和方法名应

谁践踏了优雅/ 2024年10月12日 10:51/ 0 赞/ 100 阅读

相关代码规范：遵循Java最佳实践编写程序

在Java编程中，遵循一些最佳实践可以让你的代码更清晰、可读性强。以下是一些主要的Java最佳实践： 1. **命名规则**： - 类名首字母大写（如：ClassNam

墨蓝/ 2024年10月08日 00:27/ 0 赞/ 108 阅读

相关如何编写符合规范的Controller层代码？

目录引言 1. 单一职责原则 2. 使用合适的HTTP方法 3. 使用合适的路径映射 4. 参数校验和异常处理 5. 返回合适的响应 6. 使用合适的命名规范

迷南。/ 2024年02月24日 01:16/ 0 赞/ 101 阅读

相关个人编写代码规范与快捷键

代码规范是一个逐步的过程，快捷键也是下文是本人逐步积累的过程（不断地更新与修改）一、webstorm ctrl+F：在文件内快速查找代码 ctrl+D：复制

- 日理万妓/ 2023年07月18日 06:20/ 0 赞/ 49 阅读

相关 Web入门——HTML代码编写规范

本文总结了十几条html代码编写指南，只要在编写HTML代码的过程中牢记它们，灵活运用，你一定会写出一手漂亮的代码，早日迈入专业开发者的行列。 1

我就是我/ 2022年10月01日 02:47/ 0 赞/ 277 阅读

相关 SQL编写规范

1.书写格式　　　　示例代码：　　　　存储过程SQL文书写格式例　　select 　　c.dealerCode, 　　round(sum(

亦凉/ 2022年09月20日 08:45/ 0 赞/ 24 阅读

相关 Java学习笔记5：代码标识符编写规范

1.标识符严格区分大小写 2.字母、数字、下划线（\_）、$组成 3.不能以数字开头 4.不能是关键字或保留字 5.变量、方法，总是使用小写，多个单词第一个单词

女爷i/ 2022年04月01日 11:18/ 0 赞/ 297 阅读

相关 idea Java 代码编写规范

1.[阿里巴巴Java开发手册][Java] -------------------- 2.基于上面的idea代码检查插件打开idea file–>

Dear 丶/ 2021年10月06日 12:46/ 0 赞/ 533 阅读

相关代码编写规范

一、目的为了更好的提高工作效率，保证开发的有效性和合理性，并可最大程度的提高程序代码的可读性和可重复利用性，便于交流和维护。二、命名总体规范名字应该能

逃离我推掉我的手/ 2021年09月23日 15:12/ 0 赞/ 500 阅读