你如何记录团队中的 React Native/React/Node 项目？

Question

我想了解您自己或您的团队在您的 JS 相关项目（例如 React、React Native 或 Node.js）中处理文档的方式。这包括自定义挂钩、API 方法、使用指南、辅助函数使用或任何其他需要文档才能理解的功能方法；这为未来的代码维护人员提供了理解方法的通用指南，而无需阅读各个方法代码。

我确实有几个方法：

1. 使用 JS 项目文件夹中的 .txt 文件来记下示例用法
2. 将通用文本文档存储在 Google Docs、Word 或相关平台的某个位置
3. 拥有与 TypeScript 相关的文档系统

您的团队中是否有人有任何此类做法，效果如何？

Answer 1

您可以根据自己的选择在项目中创建 markdown(.md) 文件。很明显，您将在项目中拥有不同的文件夹和子文件夹。您可以在每个文件夹中创建 markdown 文件来描述功能、特性及其用法。通过这种方式，您可以将文档保存在包含所描述功能的文件附近。

使用markdown可以很好的解释功能、逻辑、文件夹结构等，并在描述中添加一些使用代码sn-ps、外部链接、图片等。

在与团队合作时，您可能还会使用一些版本控制系统，如 GitHub、BitBucket、GitLab 等。当您创建具有特殊名称“README.md”的降价文件时，这些版本控制系统将当您打开（浏览）他们网站上的特定文件夹时，会自动显示这些 README 文件。

您可以使用以下工具：

• https://readme.so/editor（我的最爱）
• https://www.makeareadme.com/

在右侧面板上立即获取降价输出的同时非常轻松地创建自述文件。

学习markdown也很容易。您需要学习的基本知识很少，其余的取决于您以及如何使用它们。例如：

1. 使用# 添加标题
2. 使用- 或* 添加列表项
3. 将单词或句子括在反引号 (`) 中以突出显示它们
4. 要显示代码块，请将代码括在这对三个反引号内
5. 使用[]()添加链接

如果您正在寻找高级工具，那么 https://docusaurus.io/ 可能是一个很棒的选择，您可以只关注您的内容并让图书馆负责为您制作易于阅读的文档网站。