代码规范

Posted 转角90

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了代码规范相关的知识，希望对你有一定的参考价值。

1. 集成 editorconfig 配置

EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。

# http://editorconfig.org

root = true

[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格（tab | space）
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行尾的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行

[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

VSCode 需要安装一个插件：EditorConfig for VS Code

2. 使用 prettier 工具

Prettier 是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。

1.安装 prettier

npm install prettier -D

2.配置.prettierrc 文件：

  • useTabs：使用 tab 缩进还是空格缩进，选择 false；
  • tabWidth：tab 是空格的情况下，是几个空格，选择 2 个；
  • printWidth：当行字符的长度，推荐 80，也有人喜欢 100 或者 120；
  • singleQuote：使用单引号还是双引号，选择 true，使用单引号；
  • trailingComma：在多行输入的尾逗号是否添加，设置为 none，比如对象类型的最后一个属性后面是否加一个，；
  • semi：语句末尾是否要加分号，默认值 true，选择 false 表示不加；

  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": true,
  "trailingComma": "none",
  "semi": false

3.创建.prettierignore 忽略文件

/dist/*
.local
.output.js
/node_modules/**

**/*.svg
**/*.sh

/public/*

4.VSCode 需要安装 prettier 的插件

5.VSCode 中的配置

​

6.测试 prettier 是否生效

  • 测试一：在代码中保存代码；
  • 测试二：配置一次性修改的命令；

在 package.json 中配置一个 scripts：

"prettier": "prettier --write ."

3. 使用 ESLint 检测

1.在前面创建项目的时候，我们就选择了 ESLint，所以 Vue 会默认帮助我们配置需要的 ESLint 环境。

2.VSCode 需要安装 ESLint 插件：

3.解决 eslint 和 prettier 冲突的问题：

安装插件：（vue 在创建项目时，如果选择 prettier，那么这两个插件会自动安装）

npm install eslint-plugin-prettier eslint-config-prettier -D

.eslintrc.cjs 文件中添加 prettier 插件：

  extends: [
    "plugin:vue/vue3-essential",
    "eslint:recommended",
    "@vue/typescript/recommended",
    "@vue/prettier",
    "@vue/prettier/@typescript-eslint",
    \'plugin:prettier/recommended\'
  ],

4.VSCode 中 eslint 的配置

  "eslint.lintTask.enable": true,
  "eslint.alwaysShowStatus": true,
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact"
  ],
  "editor.codeActionsOnSave": 
    "source.fixAll.eslint": true
  ,

5.解决驼峰命名问题

/* eslint-env node */
require("@rushstack/eslint-patch/modern-module-resolution");

module.exports = 
  root: true,
  extends: [
    "plugin:vue/vue3-essential",
    "eslint:recommended",
    "@vue/eslint-config-typescript",
    "@vue/eslint-config-prettier/skip-formatting",
    "plugin:prettier/recommended",
  ],
  parserOptions: 
    ecmaVersion: "latest",
  ,
  overrides: [
    // 解决驼峰命名问题
    
      files: ["src/**/*.vue"],
      rules: 
        "vue/multi-word-component-names": 0,
      ,
    ,
  ],
;

4. git Husky

5. 项目基础目录

安装

  • pnpm add normalize.css: 在默认的 HTML 元素样式上提供了跨浏览器的高度一致性

编码规范篇| C#编码规范 代码规范总结，包括命名规范，代码规范 注释规范等

  • 🎬 博客主页：https://xiaoy.blog.csdn.net

  • 🎥 本文由 呆呆敲代码的小Y 原创，首发于 CSDN🙉

  • 🎄 学习专栏推荐：Unity精品学习专栏

  • 🌲 游戏制作专栏推荐：游戏制作分享

  • 🌲Unity实战100例专栏推荐：Unity 实战100例 教程

  • 🏅 欢迎点赞 👍 收藏 ⭐留言 📝 如有错误敬请指正！

  • 📆 未来很长，值得我们全力奔赴更美好的生活✨

  • ------------------❤️分割线❤️-----------------------

前言

  • 在我们程序员日常开发的过程中，会编写代码是一个最基本且常规的操作。

  • 而作为一名合格的软件工程师，出产物就应该具备工程的健壮性和美观性，因此编码规范是作为软件工程师的职业素养。

  • 但是就 编码规范 而言，可能大多数程序员都是按照自己的长久习惯进行代码编写，并没有遵循一个约定好的编码规范。

  • 所以本篇就来对C#中的编码规范做一个详细的总结整理，并对一些超级常用的做一个重点解析！

  • 对于编程而言，大多数语言的编码规范基本上是遵循一些相同的规范标准的，除去少些个语言有一些特殊用法之外。

  • 所以本篇文章不止对使用C#工程师们有帮助哦，不使用C#的小伙伴也可以看看跟自己平时用的语言有什么编码差异吧！

【编码规范篇】| C# 代码规范总结，包括命名规范，代码规范 注释规范等

一、编码规范

1.1 什么是编码规范 / Coding standards ？

  • Coding standards are collections of rules and guidelines that determine the programming style, procedures, and methods for a programming language.
  • Think of coding standards as a set of rules, techniques, and best practices to create cleaner, more readable, more efficient code with minimal errors. They offer a uniform format by which software engineers can use to build sophisticated and highly functional code.
  • 编码规范是针对某种编程语言的，决定编程风格、过程和方法的一系列规则和指导方针的集合。
  • 把编码规范看作是一套规则、技术和最佳实践，以创建更清爽、更可读、更有效的代码，并将错误降到最低。它们提供了一个统一的格式，软件工程师可以用它来构建复杂和功能强大的代码。

1.2 编码规范必要性

  • 作为一名合格的软件工程师，出产物就应该具备工程的健壮性和美观性，因此编码规范是作为软件工程师的职业素养。
  • 如果在学习编程的初期，已经认真学习过编码规范的话，那自然是没有什么任何问题的。
  • 但是对于很多初学者来说，可能对这方面并没有重视起来，还是依据自己的想法对变量和方法等等随意命名。
  • 代码不规范对于实现项目中的功能来说并没有什么太大的问题，这就好比一个人懂不懂礼貌一样，一样可以活的随心所欲。
  • 而对我们亲手编写的代码有一个规范化的管理则是我们对编程的一个最基本的尊重。
  • 所以非常建议初学者们一定要对编码规范多用点心，只要初期对这方面有一个基本的认知就可以养成一个好习惯，摆脱杂乱无章的代码啦！
  • 如果没有预先规定所有团队成员应该遵守的规范，会导致降低工程师的积极性、增加开发时间、产生复杂的代码结构等等情况。

  如果没有编码规范，团队中的每个人都按自己的编码风格来。在不久的将来，维护和调试代码将变得不容易。

  有一套编码标准在手，更容易保持代码的清晰和易于协作。当然，标准因应用、性质、行业、项目、开发人员技能和多种因素而不同。
对于一个开发团队来说，在开发过程中拥有适当的编码规范和标准是至关重要的，这将有助于团队保持代码质量，并减少新的开发人员试图理解复杂的代码库所花费的时间。

1.3 编码规范优点

  • 可有效的提高代码质量，并易于维护
  • 减少代码的复杂性
  • 易于团队合作，降低开发成本
  • 为不同工程师创建的代码提供统一规范
  • 创建出可复用的代码
  • 使得检测错误更加容易
  • 使代码更简单，更可读，更容易维护
  • 促进更合理的编程实践，提升程序员的效率，更快完成目标
  • 编码指南有助于在早期阶段发现错误，所以它有助于减少软件项目的额外成本。
  • 减少了开发软件的隐藏成本。

二、命名规范

C# 的命名有两种约定：帕斯卡拼写法(Pascal) 和 驼峰命名法(camelCasing)

  • 帕斯卡拼写法(Pascal): 成员名的每个单词的首位字母大写，如：Student，StudentName，StudentParentName。
  • 驼峰命名法(camelCasing)：成员名除了第一个单词外其余首字母都大写，Student，studentName，studentParentName.

2.1 帕斯卡拼写法(Pascal)

1.class、record及record的参数、struct的名称，如：

public class DataService



public record PhysicalAddress(
    string Street,
    string City,
    string StateOrProvince,
    string ZipCode);
    
public struct ValueCoordinate

2.命名 interface 时，使用 pascal 大小写并在名称前面加上前缀 I。 这可以清楚地向使用者表明这是 interface。

public interface IWorkerQueue

3.public的成员也应为Pascal命名，这些成员包括字段、属性、事件。
方法名也应遵循Pascal命名，无论其是否是public。如：

public class ExampleEvents

	//公共字段
	public bool IsValid;
	//公共属性
	public IWorkQueue WorkQueueget;set;
	//公共事件
	public event Action EventProcessing;
	//公共方法
	public void Run()

4.编写位置记录时，对参数使用 pascal 大小写，因为它们是记录的公共属性。

public record PhysicalAddress(
    string Street,
    string City,
    string StateOrProvince,
    string ZipCode);

2.2 驼峰命名法(camelCasing)

1.命名private或internal字段时使用驼峰命名，且字段名应以_开头。如：

public class DataService

    private IWorkerQueue _workerQueue;

2.如果是static的private或internal的字段，则字段名应该以s_开头，对于线程静态则应该使用t_开头。如：

public class DataService

    private static IWorkerQueue s_workerQueue;

    [ThreadStatic]
    private static TimeSpan t_timeSpan;

3.编写方法的参数名时，也应该以驼峰命名，如：

public T SomeMethod<T>(int someNumber, bool isValid)

2.3 其他命名约定

  1. 在不包括 using 指令的示例中，使用命名空间限定。

如果你知道命名空间默认导入项目中，则不必完全限定来自该命名空间的名称。 如果对于单行来说过长，则可以在点 (.) 后中断限定名称，如下面的示例所示。

var currentPerformanceCounterCategory = new System.Diagnostics.
    PerformanceCounterCategory();

不必更改使用 Visual Studio 设计器工具创建的对象的名称以使它们适合其他准则。

  1. 代码中当且仅当私有成员可以使用下划线_开始
  2. 代码中的命名严禁使用拼音与英文混合的方式，更不能允许直接使用中文的方式。
  3. 常量命名全部大写，单词间用下划线隔开，力求语意表达完整清楚，不要嫌名字长。
正例：MAX_XIAOY_COUNT
反例：MAX_xiaoy_COUNT
  1. 抽象类 命名使用 Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类名称开始，以Test结尾。
	/// <summary>
    /// 抽象类命名
    /// </summary>
	public void AbstractLearnProgramming()
    
    
	/// <summary>
    /// 异常类命名
    /// </summary>
	public void LearnProgrammingException()
	
	
	/// <summary>
    /// 测试类命名
    /// </summary>
	public void LearnProgrammingTest()
  1. 如果使用了设计模式，建议在类名中体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
例如：

  public class SysuserController
  public class OrderFactory
  public class TcpProxy
  1. 枚举 类名建议带上E前缀或Enum后缀，枚举成员名称需要全大写，单词间用下滑线隔开。

说明：枚举其实就是特殊的常量类i，切构造方法被默认强制是私有。
正例：枚举名字：EState / DealStatusEnum
成员名：SUCCESS / UNKOWN_REASON

三、布局规范

1.使用默认的代码编辑器设置（智能缩进、4 字符缩进、制表符保存为空格）。

2.每行只写一条语句。

    //正确
    int age = 20;
    int score = 90;

    //错误示范
    int age = 20; int score = 90;

3.每行只写一个声明。

4.C# 的大括号采用的是Allman style，大括号单独一行。以下是正确的：

    /// <summary>
    /// 正确示范
    /// </summary>
    public void StartGame()
    
    

    /// <summary>
    /// 错误示范
    /// </summary>
    public void StartGame()

5.如果连续行未自动缩进，请将它们缩进一个制表符位（四个空格）。

6.在方法定义与属性定义之间添加至少一个空白行。

    public string Name  get; set; 

    public void StartGame()

7.使用括号突出表达式中的子句，如下面的代码所示。

if ((val1 > val2) && (val1 > val3))

    // Take appropriate action.

8.if / for / while / switch / do 等保留字与左右括号之间都必须加空格。

9.任何运算符左右必须加一个空格。

说明：运算符包括赋值运算符 = 、逻辑运算符&&、加减乘除符号、三目运算符等。

10.方法参数在定义和传入时，多个参数逗号后必须加空格。
正例：下例中实参的 ” a ” ，后边必须要有一个空格。

XIaoYMethod("a", "b", "c");

四、注释规范

1.将注释放在单独的行上，而非代码行的末尾。

正确示范

    // 定义age并初始化. Define age and init.
    int age = 20;

错误示范

    int age = 20;//定义age并初始化

2.类方法的注释必须使用C# Summary 规范，以大写字母开始注释文本。

    /// <summary>
    /// Start the text with a capital letter.
    /// </summary>
    public void StartGame()

说明：在vs中，Summary方式会提示相关的注释，生成Summary可以正确输出相应的注释。工程调用方法是，不进入方法，即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

3.以句点结束注释文本。

4.在注释分隔符 (//) 与注释文本之间插入一个空格，如下面的示例所示。

// The following declaration creates a query. It does not run
// the query.

5.请勿在注释周围创建格式化的星号块。

6.请确保所有公共成员Public都有必要的注释，从而提供有关其行为的适当说明。

7.所有的抽象方法（包括接口中的方法）必须使用Summary注释，除了返回值、参数、异常说明外，还必须指出该方法做了什么事，实现了什么功能。
说明：对于子类的实现要求，或者调用注意事项，请一并说明。

8.方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。方法内部多行注释使用 /* */ 注释，注意与代码对齐。

9.语气 “ 半吊子 ” 英文来注释，不如用中文注释把问题说清楚。但专有名字与关键字保持英文原文即可。
反例： “ TCP连接超时 ” 解释成 “ 传输控制协议连接超时 ” ，理解反而费脑筋。

10.代码修改的同事，注释也要进行相应的修改，预期是参数、返回值、异常、核心逻辑等的修改。

11.注释掉的代码尽可能而配合说明，而不是简单的注释掉
说明：代码被注释掉有两种可能性：

  • 1）后续会恢复此段代码逻辑。
  • 2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。

12.对于注释的要求：

  • 第一：能够准确反应设计思想和代码逻辑；
  • 第二：能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。

完全没有注释的大段代码，对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能够清晰理解当时的思路；
注释也是给继任者看的，使其能够快读接替自己的工作。

13.好的命名、代码结构是自解释的，注释力求精简准确，表达到位。
避免出现注释的一个极端：过多滥的注释，代码逻辑一旦修改，修改注释是相当大的负担。

14.特殊注释标记，请注明标记人与标记时间。
注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1）待办事宜（TODO）：（标记人、标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。

五、代码规范/语言准则

5.1 字符串数据类型

  1. 使用字符串内插来连接短字符串，如下面的代码所示。
string displayName = $"nameList[n].LastName, nameList[n].FirstName";
  1. 若要在循环中追加字符串，尤其是在使用大量文本时，请使用 StringBuilder 对象。
var phrase = "xiaoYxiaoYxiaoYxiaoYxiaoYxiaoY";
var manyPhrases = new StringBuilder();
for (var i = 0; i < 10000; i++)

    manyPhrases.Append(phrase);

//Console.WriteLine("tra" + manyPhrases);

5.2 隐式类型本地变量

  1. 当变量类型明显来自赋值的右侧时，或者当精度类型不重要时，请对本地变量进行隐式类型化。
var var1 = "This is clearly a string.";
var var2 = 27;
  1. 当类型并非明显来自赋值的右侧时，请勿使用 var。 请勿假设类型明显来自方法名称。 如果变量类型为 new 运算符或显式强制转换，则将其视为明显来自方法名称。
int var3 = Convert.ToInt32(Console.ReadLine()); 
int var4 = ExampleClass.ResultSoFar();
  1. 请勿依靠变量名称来指定变量的类型。 它可能不正确。 在以下示例中，变量名称 inputInt 会产生误导性。 它是字符串。
var inputInt = Console.ReadLine();
Console.WriteLine(inputInt);
  1. 使用隐式类型化来确定 for 循环中循环变量的类型。
    下面的示例在 for 语句中使用隐式类型化。
var phrase = "xiaoYxiaoYxiaoYxiaoYxiaoYxiaoY";
var manyPhrases = new StringBuilder();
for (var i = 0; i < 10000; i++)

    manyPhrases.Append(phrase);

//Console.WriteLine("tra" + manyPhrases);
  1. 不要使用隐式类型化来确定 foreach 循环中循环变量的类型。 在大多数情况下，集合中的元素类型并不明显。 不应仅依靠集合的名称来推断其元素的类型。

下面的示例在 foreach 语句中使用显式类型化。

foreach (char ch in laugh)

    if (ch == 'h')
        Console.Write("H");
    else
        Console.Write(ch);

Console.WriteLine();

5.3 无符号数据类型

通常，使用 int 而非无符号类型。 int 的使用在整个 C# 中都很常见，并且当你使用 int 时，更易于与其他库交互。

5.4 数组

当在声明行上初始化数组时，请使用简洁的语法。 在以下示例中，请注意不能使用 var 替代 string[] 。

string[] xiaoY =  "x", "i", "a", "o", "Y" ;

如果使用显式实例化，则可以使用 var。

var xiaoY = new string[]  "x", "i", "a", "o", "Y" ;

5.5 委托

在用到委托时尽量使用 Func<> 和 Action<>，而不是自定义委托类型。 在类中，定义委托方法。

	public static Action<string> ActionExample1 = x => Console.WriteLine($"x is: x");

	public static Action<string, string> ActionExample2 = (x, y) => 
    Console.WriteLine($"x is: x, y is y");
    
	public static Action<string> ActionExample3 = X;

	static void X(string s)
    
		Console.WriteLine($"x is: s");
	


	public static Func<string, int> FuncExample1 = x => Convert.ToInt32(x);

	public static Func<int, int, int> FuncExample2 = (x, y) => x + y;

如果创建委托类型的实例，请使用简洁的语法。 在类中，定义委托类型和具有匹配签名的方法。

public delegate void Del(string message);

public static void DelMethod(string str)

    Console.WriteLine("DelMethod argument: 0", str);

创建委托类型的实例，然后调用该实例。 以下声明显示了紧缩的语法。

Del exampleDel2 = DelMethod;
exampleDel2("Hey xiaoY");

以下声明使用了完整的语法。

Del exampleDel1 = new Del(DelMethod);
exampleDel1("Hey xiaoY");

5.6 异常处理

1.try-catch 和 using 语句正在异常处理中
在平时使用异常处理时一般都使用 try-catch 语句。我们可以使用 using 来简化代码，简化资源的Dispose。

如果具有 try-finally语句（该语句中 finally 块的唯一代码是对 Dispose 方法的调用），可使用 using 语句代替。

如：

Font font1 = new Font("Arial", 10.0f);
try

    byte charset = font1.GdiCharSet;

finally

    if (font1 != null)
    
        ((IDisposable)font1).Dispose();

可使用using简化为：

using (Font font2 = new Font("Arial", 10.0f))

    byte charset2 = font2.GdiCharSet;

在C# 8中可以进一步简化：

using Font font3 = new Font("Arial", 10.0f);
byte charset3 = font3.GdiCharSet;

2.异常不要用来做流程控制，条件控制。因为异常的处理效率比条件分支低。

3.大段代码进行try-catch，这是不负责任的表现。catch时请分清稳定代码合肥稳定代码，稳定代码指的是无论如何都不会出错的代码。对于费稳定代码的catch尽量可能的进行区分异常类型，再做对应的异常处理。

4.捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，就将该异常抛给他的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

5.有try块放到了事务代码中，catch异常后，如果要回滚事务，一定要注意手动回滚事务。

6.finally块必须对资源对象、流对象进行关闭，有异常也要做tyr-catch。

7.捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

8.方法的返回值可以是null，不强制返回空集合或空对象等，必须添加注释充分说明什么情况下会返回null值。调用方进行null判断，防止NRE空引用异常问题（NullReferenceException）。

5.7 && 和 || 运算符

若要通过跳过不必要的比较来避免异常并提高性能，请在执行比较时使用 &&（而不是 &）和 ||（而不是 |），如下面的示例所示。

Console.Write("Enter a dividend: ");
int dividend = Convert.ToInt32(Console.ReadLine());

Console.Write("Enter a divisor: ");
int divisor = Convert.ToInt32(Console.ReadLine());

if ((divisor != 0) && (dividend / divisor > 0))

    Console.WriteLine("Quotient: 0", dividend / divisor);

else

    Console.WriteLine("Attempted division by 0 ends up here.");

如果除数为 0，则 if 语句中的第二个子句将导致运行时错误。

但是，当第一个表达式为 false 时，&& 运算符将发生短路。 也就是说，它并不评估第二个表达式。 如果 divisor 为 0，则 & 运算符将同时计算这两个表达式，这会导致运行时错误。

5.8 new 运算符 使用对象初始化值设定简化对象创建

使用对象初始值设定项简化对象创建，如以下示例中所示。

var student1 = new ExampleClass  Name = "xioaY", ID = 001,
    sex = "man", Age = 24 ;

下面的示例设置了与前面的示例相同的属性，但未使用初始值设定项。不建议使用

var student2 = new ExampleClass();
student2.Name = "xiaoYY";
student2.ID = 002;
student2.sex = "man";
student2.Age = 20;

5.9 事件处理

如果正在定义一个稍后不需要删除的事件处理程序，请使用 lambda 表达式。

public Form1()

    this.Click += (s, e) =>
        
            MessageBox.Show(
                ((MouseEventArgs)e).Location.ToString());
        ;

Lambda 表达式缩短了以下传统定义。

public Form1()

    this.Click += new EventHandler(Form1_Click);


void Form1_Click(object? sender, EventArgs e)

    MessageBox.Show(((MouseEventArgs)e).Location.ToString());

5.10 静态成员

使用类名调用 static 成员：ClassName.StaticMember。
这种做法通过明确静态访问使代码更易于阅读。 请勿使用派生类的名称来限定基类中定义的静态成员。

编译该代码时，代码可读性具有误导性，如果向派生类添加具有相同名称的静态成员，代码可能会被破坏。

5.11 OOP面向对象规约

1.避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可

2.不能使用过时的类或方法（[Obsolate]标识）
说明：C#中对于标记过时的方法，有可能会在新版本的.Net Framework中剔除，因此不建议继续使用

以上是关于代码规范的主要内容，如果未能解决你的问题，请参考以下文章

青青草原--团队作业6:代码规范

是否需要有代码规范

Beta冲刺代码规范

作业三: 代码规范代码复审PSP

作业三: 代码规范代码复审PSP

代码规范代码复审PSP