本文主要记录 C# 中的一些命名规范问题,文章内容会根据个人的学习进度进行更新。
个人认为好的编程习惯是非常重要的,整洁规范的代码可以显著地提高可读性,既方便开发者的维护,也可以使读者身心愉悦。
PS:该命名规范有一定程度的个人主观因素,仅供参考。
接口 interface
使用帕斯卡命名规则。
以大写字母 I 开头。
类 class
使用帕斯卡命名规则。
类名应该是能够反映类功能的名词,或名词短语。
字段 field
字段一般是私有的,用 private 修饰。
bool 类型的字段一般根据含义以 is / can / has 等作为前缀。
bool 类型的方法同理。
私有字段 private field
以 “_” 作为前缀,使用驼峰命名规则。
公共字段 public field
使用帕斯卡命名规则。
属性 property
使用帕斯卡命名规则。
属性一般是公有的,用 public 修饰。
方法 method
使用帕斯卡命名规则。
方法名应该是动词,或者动宾短语。
动词的选择
动词类别 | 单词 |
---|---|
添加 / 插入 / 创建 / 初始化 / 加载 | add, append, insert, create, initialize, load |
删除 / 销毁 | delete, remove, destroy, drop |
打开 / 开始 / 启动 | open, start |
关闭 / 停止 | close, stop |
获取 / 读取 / 查找 / 查询 | get, fetch, acquire, read, search, find, query |
设置 / 重置 / 放入 / 写入 / 释放 / 刷新 | set, reset, put, write, release, refresh |
发送 / 推送 | send, push |
接收 / 拉取 | receive, pull |
提交 / 撤销 / 取消 | submit, cancel |
收集 / 采集 / 选取 / 选择 | collect, pick, select |
提取 / 解析 | sub, extract, parse |
编码 / 解码 | encode, decode |
填充 / 打包 / 压缩 | fill, pack, compress |
清空 / 拆包 / 解压 | flush, clear, unpack, decompress |
增加 / 减少 | increase, decrease, reduce |
分隔 / 拼接 | split, join, concat |
过滤 / 校验 / 检测 | filter, valid, check |
名词的选择
名词类别 | 单词 |
---|---|
容量 / 大小 / 长度 | capacity, size, length |
实例 / 上下文 | instance, context |
配置 | config, settings |
头部 / 前面 / 前一个 / 第一个 | header, front, previous, first |
尾部 / 后面 / 后一个 / 最后一个 | tail, back, next, last |
区间 / 区域 / 某一部分 / 范围 / 规模 | range, interval, region, area, section, scope, scale |
缓存 / 缓冲 / 会话 | cache, buffer, session |
本地 / 局部 / 全局 | local, global |
成员 / 元素 | member, element |
菜单 / 列表 | menu, list |
源 / 目标 | source, destination, target |