我正在与一群其他程序员合作开发一个使用 C++ 和 Qt 构建的开源项目。
现在,我们需要一个小部件(以及其他变量)的命名约定,以将其用作所有代码中的标准,以便代码获得更好的可读性,并且我们可以在程序员之间获得更好的协调。
有什么建议吗?
编辑:我不是在谈论命名新类,
相反,我谈论的是 Qt Widgets 的命名实例,假设我有一个用户名文本编辑,我应该将其命名为 txtEdtUsrNm 吗?
那么,我该如何选择推导呢?
只要您沿着这些思路思考,我就会从头到尾阅读这篇 QtQuarterly 文章。
设计 Qt 风格的 C++ API https://doc.qt.io/archives/qq/qq13-apis.html
也就是说,我们做的一件事是将实例的“使用”作为第一部分,将类的最后一个完整单词作为最后部分。
所以,你的“用户名”QTextEdit 是
QTextEdit * userNameEdit = new QTextEdit(this);
如果存在歧义,例如 QListView 和 QTreeView,请选择最后一个明确的部分。
QListView * userListView;
您可以根据自己的喜好找出缩写(例如 QLabel 的“Lbl”),但一般来说,整个单词都有效且易于阅读。
另一方面,我们对此并不太严格,在不带类名的情况下命名实例变量的意图可能更重要,因为如果将来您想更改类,则可以更改名称在缺乏良好的重构工具的情况下,这是一种痛苦。
也许找出您最常使用的通用小部件,并为最通用的超类选择一个命名约定,然后放开其他一切。
遵守约定的事项示例列表:
- 布局 = 所有以以下结尾的类
“布局”并继承QLayout
- Button = 所有以“Button”结尾并继承QAbstractButton的类
QA摘要班级名称类是思考列表中应该包含哪些内容的好地方。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)