Naming Conversion & Case Style 命名规范

前言

写代码有 2 个点很重要

第一是表达 (不要词不达意)

要达到这点, 就要多参考其它人如何表达. 

第二是一致性 (一样的东西就用一样的写法)

要达到这点就要建立规范

以前的笔记

命名规范 naming conversion, camel case, pascal case, hyphen 等等

ASP.NET Core – Case Style Conversion

Case Style

pascal case = PascalCase

camel case = camelCase

kebab case = kebab-case (通常是 lower case)

snake case = snake_case

upper case = UPPERCASE

lower case = lower case

title case = Blog Title

以下是我自己的规范和学习笔记

Url Case Style

Url 用 kebab-case

query params 用 snake_case (oauth) 或 camelCase (gmail),

我选 camelCase 因为 ASP.NET Core 用 action parameter 来获取 route param 而它是 camelCase

Folder and File Case Style

参考一些开源库: 

.NET = PascalCase

Angular = forlder: kebab-case, file: snake_case

Angular Material = kebab-case

React = forlder: kebab-case, file: camelCase

Vue = folder: kebab-case, file: PascalCase or camelCase

Me = need url access: kebab-case, 前端: kebab-case, 后端: PascalCase, 

Folder and File Path Naming Conversion

参考:

What is the naming standard for path components?

FileRootFullPath = C:\Project\Hydro\wwwroot\uploaded-files\image.jpg

FileFullPath = wwwroot\uploaded-files\image.jpg (从 Project 走起, 而不是 C drive, 不一定是 wwwroot, 这里只是一个 example)

FileName = image.jpg

FileNameWithoutExtension = image

Extension = .jpg

DirectoryName = uploaded-files (和 .net 有分歧)

DirectoryRootFullPath = C:\Project\Hydro\wwwroot\uploaded-files 

DirectoryFullPath = wwwroot\uploaded-files 

RelativePath = ./ or ../

AbsolutePath = ~/abc/xyz

DirectoryPath = "abc\xyz"

Folder vs Directory

folder 通常是用在 UI 上, 程序基本上都会叫 directory(目录). 参考: stackoverflow – What is the difference between a directory and a folder?

C# Case Style

class name = PascalCase

property name = PascalCase

enum = PascalCase

filed = camelCase

private field = _camelCase

variable = camelCase

parameter = camelCase

local function = PascalCase

Tuple

ValueTuple naming conventions

调用和定义都可以是 PascalCase or camelCase.

如果调用的时候是当 object 用, 那么 property 就应该是 PascalCase. 如果是当解构 variables 用, 那就是 camelCase 合理些. 

关键点是, 定义的时候用 PascalCase, 调用 property ok, variables 就 rename, 也 ok. 

定义用 camelCase, 调用 property 就坏掉了. 

所以定义的时候用 PascalCase 会好一点, 但如果可以确定使用时是 variables, 那我觉得定义时用 camelCase 也是可以的. 比如用 Tuple 做 Action 的 parameters 的时候.

ASP.NET Core Case Style

Razor Pages use async suffix

Web API don't use async suffix

Razor Pages handler 

官网的例子是

/external-login?handler=AccessDenied 

/customer?handler=delete

单字就 lowercase, 多字就 PascalCase

我个人觉得, 统一用 PascalCase 会更好.

JS / TS Case Style

class name = PascalCase

enum = PascalCase

property name = camelCase

variable = camelCase

parameter = camelCase

custom dom event name = lowercase (follow 原生)

其它:

可传递函数 endswith Fn e.g. compareFn (这个是 follow Angular 的, 以前我是放 compareFunc 的)

SQL Case Style

database name = PascalCase

table name = PascalCase (Singular)

column name = PascalCase

query = UPPERCASE

variable = camelCase

trigger name for redundacy = TR_TableName_AfterInsert_ForRedundancy_TableName_ColumnName (第 1 个 table name 是被监听的, 第 2 个是冗余 table)

trigger name for cascade = TR_TableName_InsteadOfDelete_ForCascade_TableName (第 1 和第 2 table name 是一样的)

抽象的 array 和 object 命名

EPPlus 叫 foreach (var item in collection)

有些人叫 foreach (var obj in objects)

有些人叫 foreach (var data in dataList)

我选 EPPlus