是时候编写代码文档了。
由于该项目对我来说是一个全新的领域并且属于我不喜欢的（我的主观意见）javascript并且包括功能组件React，因此实际的问题是：
组件是如何记录的React（如果很重要，它们绝对都是功能性的)，包括那些包含嵌套组件的？您可以诚实地忽略什么？
RError.com
最重要的是记录逻辑（业务逻辑）。这必须首先完成。具体如何做到这一点取决于团队 - 因为它对您来说更方便。尝试查看文档并选择最适合您的选项。
如果您的项目变得非常大，并且是时候将组件移动到单独的库中，那么您也可以记录这个库。就个人而言，我更喜欢React Styleguidist。但它不是针对 React Native，而是针对 React。但是，React Native 也有替代方案。
什么是组件。组件是一个 React 对象。手段和记录它是必要的对象。一个漂亮的评论是当你有一个函数签名时，它做了什么，它返回了什么。以及为什么需要它。最难理解的一段代码是签名的，在糟糕的 TODO 情况下，真正需要做什么（当然最好使用问题跟踪器）。不必对代码部分进行签名，例如“将计数器增加 1”。
当被问及如何签名时，最好使用@JSDoc https://jsdoc.app/ 95% 的优秀 IDE 都支持它，并且使用@JSDoc Search 程序员可以很容易地理解和重用您的代码。
并且在任何情况下都不要使用具有短名称的变量！如果对站点的请求称为“请求”，则使用完整的单词“请求”（不是“req”、“reqst”等）。好的代码首先应该像书一样易于阅读。
与函数/组件/控制器的名称相同，例如 BlogPost 组件应命名为 BlogPostComponent、BlogPostPreviewComponent 等。不仅仅是在 blog/Post.jsx 和 blog/preview/Post.jsx 中发布
在以下情况下美丽且最重要的是清晰：
至于代码本身，我强烈建议您尽快切换到 TypeScript 并以至少“标准”模式连接 ESLint——这将在开发时修复一堆错误。如果 linter 不检查代码（githooks），几乎我们所有的项目都无法上传到 git。