关于变量、函数等的命名

自从接触前端以来,一直被一件事所困扰——取名无能。class、id、变量、函数、对象……  想名字是一件很头疼的事情。最近百度上看到一篇关于命名的一些词汇(http://www.cnblogs.com/iyueyao/p/3777678.html),可以借鉴一下。


函数命名:统一使用动词或者动词+名词形式 ---- fnInit()

如果有内部函数则“_”开头   _fnInit().

对象方法命名使用fn+对象类名+动词+名词形式   fnAnimateDoRun() 

某事件响应函数命名方式为fn+触发事件对象名+事件名或者模块名  fnDivClick()

常用的动词列表:

get 获取/set 设置, add 增加/remove 删除
create 创建/destory 移除 start 启动/stop 停止
open 打开/close 关闭, read 读取/write 写入
load 载入/save 保存, create 创建/destroy 销毁
begin 开始/end 结束, backup 备份/restore 恢复
import 导入/export 导出, split 分割/merge 合并
inject 注入/extract 提取, attach 附着/detach 脱离
bind 绑定/separate 分离, view 查看/browse 浏览
edit 编辑/modify 修改, select 选取/mark 标记
copy 复制/paste 粘贴, undo 撤销/redo 重做
insert 插入/delete 移除, add 加入/append 添加
clean 清理/clear 清除, index 索引/sort 排序
find 查找/search 搜索, increase 增加/decrease 减少
play 播放/pause 暂停, launch 启动/run 运行
compile 编译/execute 执行, debug 调试/trace 跟踪
observe 观察/listen 监听, build 构建/publish 发布
input 输入/output 输出, encode 编码/decode 解码
encrypt 加密/decrypt 解密, compress 压缩/decompress 解压缩
pack 打包/unpack 解包, parse 解析/emit 生成
connect 连接/disconnect 断开, send 发送/receive 接收
download 下载/upload 上传, refresh 刷新/synchronize 同步
update 更新/revert 复原, lock 锁定/unlock 解锁
check out 签出/check in 签入, submit 提交/commit 交付
push 推/pull 拉, expand 展开/collapse 折叠
begin 起始/end 结束, start 开始/finish 完成
enter 进入/exit 退出, abort 放弃/quit 离开
obsolete 废弃/depreciate 废旧, collect 收集/aggregate 聚集

  

变量命名:

一些算是默认的规范就不说了 (常量大写,循环变量简写,驼峰式等)

对于变量命名 还是没有一个规范,下面贴出一个别人的规范仅供参考。

按照类型规划:

s:表示字符串。例如:sName,sHtml;
n:表示数字。例如:nPage,nTotal;
b:表示逻辑。例如:bChecked,bHasLogin;
a:表示数组。例如:aList,aGroup;
r:表示正则表达式。例如:rDomain,rEmail;
f:表示函数。例如:fGetHtml,fInit;
o:表示以上未涉及到的其他对象,例如:oButton,oDate;
g:表示全局变量,例如:gUserName,gLoginTime;

  

按照前缀区分 :

$:表示Jquery对象。例如:$Content,$Module;
一种比较广泛的Jquery对象变量命名规范。
j:表示Jquery对象。例如:jContent, jModule;
另一种Jquery对象变量命名方式。
fn:表示函数。例如:fnGetName,fnSetAge;
和上面函数的前缀略有不同,改用fn来代替,个人认为fn能够更好的区分普通变量和函数变量。
dom:表示Dom对象,例如:domForm,domInput;
项目中很多地方会用到原生的Dom方法及属性,可以根据团队需要适当修改。



### 函数变量命名规范与最佳实践 在编程中,函数变量命名规范对于代码的可读性、可维护性和协作效率至关重要。以下是关于函数变量命名的一些重要规则和最佳实践: #### 变量命名规范 变量命名应当清晰明了,便于理解其用途。以下是一些常见的变量命名规则[^1]: - **描述性强**:变量名称应该能够清楚表达其所代表的数据或对象的意义。 - **大小写约定**:不同语言有不同的惯例。例如,在 Python 中推荐使用小写字母加下划线的方式(snake_case),而在 JavaScript 或 Java 中则更倾向于驼峰式命名法(camelCase)。 - **避免歧义**:不要使用容易引起误解的名字,比如单字母变量除非是在循环计数等非常短且明确的情况下。 #### 函数命名规范 函数作为程序逻辑的核心组件之一,其命名同样需要遵循一定的标准来提升代码质量。具体如下[^3][^4]: - **动词开头**:为了体现动作或者行为,建议以动词开始定义函数名,这样可以帮助开发者快速识别该方法的功能是什么。 - **全小写并用下划线分割单词**:这符合 PEP8 对于 Python 的指导原则,有助于保持一致性。 - **避开关键字冲突**:确保所选名称不会与任何已存在的类库成员或其他内置功能发生重叠。 - **意义明确**:如同变量一样,好的函数名字可以让读者无需查看内部实现就能大致猜到它的作用范围及其返回值类型。 下面给出一段基于上述准则编写的小型 Python 程序片段展示如何应用这些概念: ```python def calculate_total_price(items, tax_rate): total = sum(item['price'] * item['quantity'] for item in items) taxed_amount = total * (tax_rate / 100) final_total = total + taxed_amount return round(final_total, 2) shopping_cart = [ {"product": "apple", "price": 0.99, "quantity": 5}, {"product": "banana", "price": 0.75, "quantity": 3} ] sales_tax_percentage = 8.25 total_cost = calculate_total_price(shopping_cart, sales_tax_percentage) print(f"The total cost including taxes is ${total_cost}") ``` 此示例展示了恰当运用有意义的变量函数命名可以使整个脚本更加直观易懂。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值