- 🐚作者简介:花神庙码农(专注于Linux、WLAN、TCP/IP、Python等技术方向)
- 🐳博客主页:花神庙码农 ,地址:https://blog.csdn.net/qxhgd
- 🌐系列专栏:C语言编程
- 📰如觉得博主文章写的不错或对你有所帮助的话,还望大家三连支持一下呀!!! 👉关注✨、点赞👍、收藏📂、评论。
- 如需转载请参考转载须知!!
引言
- Phil Karlton曾经曰过:计算机科学领域有两个难题:一个是缓存失效,另一个就是命名。
- Quora(美国知乎)上做的一个统计,有接近一半的人认为命名对于程序员一个很棘手的事情。
- 本文探讨了关于命名的一些思考及手段。
软件命令层次
- 产品命名 ,一般由产品经理来对产品进行命名,如华为的麒麟芯片,鸿蒙系统等;
- 项目命名 ,一般由项目经理命令,如TP500;
- 软件命名,这里是程序员的地盘:
– 文件夹命名,如bridge;
–文件命名,如br_forward.c;
–文件内命名,也即编程语言中的元素(函数、变量、宏、枚举等),如br_flood函数。
变量命名的要点
- 变量内容:代表的是什么含义,如skb、dev等;
- 变量类型:整型、浮点型、布尔、结构体、指针等,如dwSum;
- 变量位置:全局变量、局部变量、模块、类等,如g_ctl_flags;
- 可读性:关注变量名的大小写、下划线、长度、相似性等因素;
- 可移植性:关注变量名是否通用,是否依赖于项目、产品等;
具体的变量命名可参考上述几个角度,一个典型的变量名如下:
DWORD g_dwDfsThresh;
变量命名的工具
CODELF
- 该工具通过搜索,在线开源平台Github, Bitbucket, Google Code, Codeplex, Sourceforge, Fedora Project的开源项目源码,帮开发者从中找出已有的匹配关键字的变量名,从而帮助开发者命名变量。
- 官方链接:codelf,vscode中有对应插件。
CHTML
- chtml即code helper tag mark law,代码辅助标记方法,是一款简洁好用的在线的代码命名工具、变量命名工具、变量命名规则库,使用它可以让您轻松摆脱翻译软件的困扰,快速选择合适的变量名称用于开发工作中。
- 官方链接:chtml,vscode中有对应插件。
如本文对你有些许帮助,欢迎大佬支持我一下,您的支持是我持续创作的不竭动力
支持我的方式