小能豆

reactJS 中的文件命名约定?

javascript

最近开始学习 ReactJS,唯一让我困惑的是React 应用目录中文件夹和文件的命名。

对于组件文件的命名,有的人遵循TitleCase.js,有的人遵循camelCase.js。

对于应用程序目录的名称,很少有人遵循camelCase,也很少有人 smallcase或small-case。

我尝试查找有关命名约定的官方文档,但找不到。有人能帮我找到在 ReactJS 中命名文件的正确方法吗?


阅读 64

收藏
2024-06-16

共1个答案

小能豆

React 项目中的命名约定可能有所不同,尽管 React 团队没有官方文档规定特定的约定,但您可以遵循一些广泛接受的做法。这些约定旨在提高可读性和可维护性。以下是有关 React 项目中文件和文件夹的常见命名约定的指南:

组件文件

  1. 标题大小写 (PascalCase) :
  2. 用法:这是命名 React 组件文件最常见的约定。
  3. 原因:它符合使用 TitleCase 命名 React 组件的惯例,从而可以轻松区分组件和常规 JavaScript 文件。
  4. 例子MyComponent.js
  5. 例子
  6. Button.js
  7. UserProfile.js
  8. Header.js

文件夹名称

  1. camelCase:
  2. 用途:通常用于包含相关 JavaScript 文件的目录,例如钩子、上下文和实用函数。
  3. 例子src/hooks/useFetch.js
  4. kebab-case(小写)
  5. 用法:这是命名文件夹的常见选择,因为它易于阅读并且避免与 JavaScript 变量混淆。
  6. 例子src/components/user-profile/UserProfile.js

目录结构

以下是具有推荐命名约定的典型 React 项目结构的示例:

src/
  components/
    Header/
      Header.js
      Header.css
    UserProfile/
      UserProfile.js
      UserProfile.css
  hooks/
    useFetch.js
    useAuth.js
  utils/
    formatDate.js
    calculateAge.js
  App.js
  index.js

最佳实践摘要

  1. 组件文件
  2. 对 React 组件文件使用TitleCase (PascalCase)。
  3. 如果每个组件具有相关的样式或测试,则理想情况下应该将其放在自己的文件夹中。
  4. 文件夹名称
  5. 文件夹名称使用短横线命名法。这样可以使其易于区分和阅读。
  6. 在实用程序或钩子目录中使用驼峰式命名法(camelCase)来命名特定文件名。
  7. 一致性
  8. 一致性是关键。选择一个惯例并在整个项目中坚持下去。
  9. 确保您的团队对所选择的惯例达成共识,以保持一致性。

结论

虽然没有关于命名约定的官方 React 文档,但遵循这些被广泛接受的做法将帮助您维护干净且井然有序的代码库。关键是保持一致并选择对您的项目和团队有意义的约定。

2024-06-16