如何在团队中记录React Native/React/Node项目?

Question

我想了解您或您的团队在js相关项目(如React, React Native或Node)中处理文档的方法。这包括自定义钩子、API方法、使用指南、辅助函数用法或任何其他需要文档才能理解的函数方法;这为未来的代码维护者提供了一个理解方法的通用指南，而不必阅读单个方法代码。

我确实有一些方法:

1. 在JS项目文件夹中使用.txt文件记录示例用法
2. 有一个通用的文本文档存储在谷歌文档，Word或相关平台的某处
有一个TypeScript相关的文档系统

在你的团队中是否有人有这样的做法，它是如何工作的?

Answer 1

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

使用markdown，你可以很好地解释函数、逻辑、文件夹结构等，并在你的描述中添加一些使用代码片段、外部链接、图像等。

当你和团队一起工作时，你可能也会使用一些版本控制系统，比如GitHub, BitBucket, GitLab等。当您将创建具有特殊名称"README"的标记文件时。，那么当你打开(浏览)他们网站上的特定文件夹时，这些版本控制系统会自动显示这些自述文件。

您可以使用以下工具:

• https://readme。so/editor(我的最爱)
• https://www.makeareadme.com/

可以很容易地创建自述文件，同时在右侧面板上立即获得markdown的输出。

学习降价也很容易。你需要学习的基本东西很少，剩下的就取决于你和你如何使用它们。例如:

1. 使用#添加标题
2. 使用-或*添加列表项
3. 将单词或句子括在反号(')中以突出显示
4. 要显示代码块，请将代码包含在
中。
5. 使用[]()添加链接

如果您正在寻找一个高级工具，那么https://docusaurus.io/可以是一个很棒的选择，只关注您的内容，让库为您提供易于阅读的文档网站。