通用编程命名规范

鬼谷子叔叔 - 2024-03-22 12:00

类

资源类

资源类以资源名称命名，例如：user、article等等。

模块类

模块类以资源名称加“Model”命名，例如：userModel，articleModel等等。

控制器类

资源控制器类以资源名称加“Controller”命名，例如：userController，articleController等等。

非资源控制器类以页面内容取名加“Controller”命名，例如：helpController，aboutusController等等。

类方法

CRUD

CRUD是create、retrieve、update和delete的缩写，意思是创建、检索、更新、删除四个基本操作。

在对CRUD事件的方法命名，可以使用insert、update、delete和select，它们更像数据库的SQL语句。

也可以使用add、modify、remove、load，它们区别于前面的四个SQL风格的命名方式。

变量

基础类型

基础类型变量可以用小写的类型首字母作为变量的前缀，例如：iUserId、sUserName等等。

字典（映射）

字典类变量可以使用Item/Info/Map作为变量后缀。

列表

列表类变量就是把列表里的内容的名字复数化，例如：userItem就是userItems，userInfo就是userInfos，userMap就是userMaps。

常用行为单词使用场景

单词	场景
get	获取，获取指定内容，主要是获取本地数据。例如：getUserData（获取用户数据），user.getData（获取用户数据）。
set	设置，设置指定内容，通常情况下内容是临时设置的。例如：setParams（设置参数）
load	加载，加载指定内容，内容是为了当前进程使用的，有时候也用于一个事件的启动。例如：loadUser（加载用户数据），user.load（加载用户数据），page.load（加载页面）。
update	更新，更新指定内容，内容必须的已经存在的，只是进行更新操作。例如：updateUser（更新用户数据），user.update（更新用户数据）。
save	存储，存储指定内容，通常情况下内容是需要持久化存储的，内容不存在就进行创建操作，存在就进行更新操作。例如：saveUser（保存用户数据），user.save（保存用户数据）。
make	制作，制作指定内容，内容是需要加工、组装、整理等等处理的。例如：makeIcon（制作图标），icon.make（制作图标）。
run	执行，执行命令，一般情况下就是执行一个长时间运行的命令。例如：runService（执行服务），service.run（执行服务）。
start	启动，启动进程，一般情况下就是启动一个长时间运行的进程。例如：startSync（启动同步），sync.start（启动同步）。
dispatch	派发，派发任务，一般情况下就是派发一个处理请求。例如：dispatchProcess（派发处理事件），process.dispatch（派发处理事件）

https://docker.mirrors.sjtug.sjtu.edu.cn/

https://docker.nju.edu.cn/

https://docker.m.daocloud.io/

鬼谷子叔叔
跟福哥学编程吧~~

热度 1626

文章 212