通用编程命名规范

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

资源类

资源类以资源名称命名,例如:user、article等等。

模块类

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

控制器类

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

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

类方法

getXXX

以get开头的用于给获取某些内容的方法命名,通常情况下这些内容是现成的,不需要加工的,或者只需要简单加工的。

setXXX

以set开通的用于给设置某些内容的方法命名,内容类型同getXXX方法。

loadXXX

以load开头的用于给加载某些内容的方法命名,通常情况下这些内容是需要从某些引擎或媒介里面提取的,如:数据库、文件等等。

saveXXX

以save开头的用于给保存某些内容的方法命名,内容类型同saveXXX方法。

CRUD

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

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

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