Flutter 变量命名最佳实践

视频

https://youtu.be/t5miWCdbilA

https://www.bilibili.com/video/BV1PC4BeGEvp/

前言

原文 Flutter变量命名最佳实践

本文介绍了Flutter开发中的变量命名最佳实践，帮助开发者提升代码的可读性和可维护性。

最好在项目中建立命名约定并遵守它。这使得你的代码便于维护和阅读，这对你和团队成员都有益。

正文

文件名

所有文件（包括资源）采用 小写+下划线 命名。
```
home_page.dart
```
用词信、雅、达。
1. 信：指表达的内容要真实、准确、可信。写作时应确保信息的真确性和可靠性，避免误导读者。
2. 雅：指语言要优雅、得体、文雅。使用恰当的词汇和语法，使得表达更加高尚和有品位，符合文化和审美的要求。
3. 达：指表达要畅达、明了、易懂。语言应简洁明了，便于读者理解，确保信息传达的有效性。
```
user_edit_profile_page.dart
```

类命名

表明其内容+身份+用途

使用大驼峰命名。同样适用于枚举和扩展函数。

class Foo , extension Bar<T>

超过两个字母的大写缩略词当做一般单词对待。两个字母的单词除外。

// 好
HttpConnectionInfo , IOStream , Id

// 不好
HTTPConnection , IoStream , ID

不要超过5个单词。如果超过了，应该考虑是否为命名或拆分不当。

清晰性和描述性

变量命名的主要目标是清晰地传达变量的用途和内容。选择能够自解释且准确反映其所存储数据的名称。

- 好
firstName, totalPrice, productDescription

- 不好
x ， a ， temp

使用有意义的词语

避免使用可能使其他开发人员困惑的缩写或过于技术性的行话。

- 好
customerName, orderStatus, employeeRecord

- 不好
custNm, ordSt, empRec

驼峰命名法

最广泛采用的变量命名规范是驼峰命名法。

- 好
fullName, dateOfBirth, shippingAddress

- 不好
full_name, dateofbirth, shipping_address

常量大写

如果你有存储常量值且不应被修改的变量，请用大写字母声明，并用下划线分隔单词。

- 好
TAX_RATE, API_KEY, MAX_ATTEMPTS

- 不好
taxRate, apiKey, maxAttempts

避免使用单字母变量

虽然单字母变量在快速迭代时可能很有诱惑力，但它们通常会使代码的可读性降低。

- 好
counter, index, sum

- 不好
i, j, k

数组使用复数形式

如果您的变量表示数组，请使用复数名称来表示它包含多个元素。

- 好
productNames, orderItems, employeeList

- 不好
productName, orderItem, employee

前缀布尔变量

对于布尔变量，考虑使用前缀如 is 、 has 或 can 以明确其用途。

- 好
isActive, hasDiscount, canEdit, isLoggedIn

- 不好
active, discountApplied, editEnabled, loggedIn

作用域命名

如果你在特定作用域中使用变量，请考虑加入表示其作用域的前缀或后缀。

- 好
globalCounter, localIndex, moduleSpecificConfig

- 不好
counter, index, config

单独声明

单独声明每个变量以提高可读性是一个好习惯。

- 好
var isActive = false;
var canEdit = true;

- 不好
var isActive = false, canEdit = true;

小结

在Flutter开发中，良好的变量命名是提升代码可读性和维护性的关键。本文提供的变量命名最佳实践，旨在帮助开发者在编写Flutter代码时遵循清晰、一致的命名规范。通过遵循这些指导原则，你可以显著提高Flutter项目的可维护性，并减少后期的开发成本。合理的命名不仅提高了团队协作效率，也为代码的未来扩展打下了坚实的基础。

感谢阅读本文

如果有什么建议，请在评论中让我知道。我很乐意改进。

猫哥 APP

flutter 学习路径

end

Flutter 变量命名最佳实践