文档生成
====

DevEco Studio支持通过Generate ArkTSDoc功能，将代码文件中变量、方法、接口、类等需要对外暴露的信息快速生成相应的参考文档。

从DevEco Studio 6.1.0 Beta1版本开始，ArkTSDoc功能支持多模块导出，以及导出时支持设置不需要被导出的目录。

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/bf/v3/dmiToK-JTgCPILzmpeoOZA/note_3.0-zh-cn.png?HW-CC-KV=V1&HW-CC-Date=20260612T073853Z&HW-CC-Expire=86400&HW-CC-Sign=C2844A91E2C9FE374674D2CB3DA1C504AED4A7E1351650BD3E82D3E764018974)

*   当前支持对工程或目录下.ets/.ts/.js/.md格式文件生成ArkTSDoc文档。
*   文件中export的变量、方法、接口、类等将生成相应的ArkTSDoc文档，未export的对象不支持生成。
*   若选择对工程/目录整体导出ArkTSDoc文档，生成后的ArkTSDoc文档目录和原目录结构一致。

#### 生成步骤

1.  在菜单栏选择**Tools >** **Generate ArkTSDoc...**进入ArkTSDoc生成界面。
2.  设置生成ArkTSDoc的范围，可选择整个工程、单个模块或多个模块，某个目录或单个文件进行导出。
    
    点击**Modules**后的下拉箭头，会弹出所有模块，可以选择单个或多个模块作为导出范围。当模块数量较多时，可以使用检索功能，快速定位模块。
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/5a/v3/KRPYNqEATvOg4RuEYkwcLQ/zh-cn_image_0000002594475010.png?HW-CC-KV=V1&HW-CC-Date=20260612T073853Z&HW-CC-Expire=86400&HW-CC-Sign=63B27AA9E560B5F218DC857245954991EA5DA5DA4EF2B09FC2834896B3A40C7B)
    
3.  在导出时，可以在**Command line arguments**设置无需被导出的目录，使用"-e"子命令进行指定，多个目录使用英文";"分隔，使用"./"开头路径代表项目根路径。
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/fc/v3/1i8osFG6QdqBQl6SnNBoOQ/zh-cn_image_0000002624994371.png?HW-CC-KV=V1&HW-CC-Date=20260612T073853Z&HW-CC-Expire=86400&HW-CC-Sign=F8A4B7354A755411F70915452191B87F63876E573435244404CB38FA13B4FE7E)
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/bc/v3/twNLW7OVRwCySbq0BWizrw/note_3.0-zh-cn.png?HW-CC-KV=V1&HW-CC-Date=20260612T073853Z&HW-CC-Expire=86400&HW-CC-Sign=B6D52AE5757815B837367030FF9347CC28C72A9E9F94361F2F9C6653069E139B)
    
    从DevEco Studio 6.1.0 Release版本开始，**Command line arguments**填写时支持Ant风格的路径匹配模式。在Ant风格中，使用'?'匹配单字符、'\*'匹配单层目录/文件、'\*\*'匹配任意层目录等。
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/91/v3/2hOm38XXSVelt7kdts5SlA/zh-cn_image_0000002625074511.png?HW-CC-KV=V1&HW-CC-Date=20260612T073853Z&HW-CC-Expire=86400&HW-CC-Sign=2AD115436289141F63B04A8127A6C138A747371294AAF6DE334BBF53D4AA79C3)
    
4.  在**Output directory**中输入导出ArkTSDoc的存储路径后，点击**Generate**。
5.  若勾选**Open generated documentation in browser**选项，在生成ArkTSDoc后，将自动打开相应页面查看生成的文档。配置完毕后点击Generate，开始扫描并生成ArkTSDoc文档。
    
    生成的ArkTSDoc左侧文档目录和原工程目录结构一致，右侧可点击跳转到当前文件包含的某个变量、方法、接口或类的文档位置。
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/eb/v3/x0kJog7WT3aVr2wLMzySuA/zh-cn_image_0000002625074513.png?HW-CC-KV=V1&HW-CC-Date=20260612T073853Z&HW-CC-Expire=86400&HW-CC-Sign=8856B9B95C06DF0C5937D695EC703129D90A8DFC2ED3915D8C74ADD4F38A4166 "点击放大")
    
    若没有勾选**Open generated documentation in browser**选项，在生成ArkTSDoc后，DevEco Studio右下角弹出对应提示框，可以点击Go to Folder跳转到生成的ArkTSDoc文件夹，用浏览器打开文件夹中index.html文件即可查看ArkTSDoc文档。
    

#### 生成效果示例

**注释格式要求：**当前仅支持“/\*\* \*/”文档注释格式；支持param等[标准标签](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-arktsdocs-standard-label)和myTag等自定义标签生成相应文档。

/\*\*
 \* Prints "log" logs.
 \*
 \* @param { string } message - Text to print.
 \* @myTag
 \* @since 11
 \*/

**代码示例：**

/\*\*
 \* Defines the demo class
 \*
 \* @since 11
 \*/
export class Demo {
    /\*\*
     \* Prints "log" logs.
     \*
     \* @param { string } message - Text to print.
     \* @myTag
     \* @since 11
     \*/
    static log(message: string): void {
        
    }
}

**ArkTSDoc文档生成结果：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/f5/v3/MLo0NvyyTuaM-VGrt22UFQ/zh-cn_image_0000002624994373.png?HW-CC-KV=V1&HW-CC-Date=20260612T073853Z&HW-CC-Expire=86400&HW-CC-Sign=B6B5841322DFC0A983406424D4B30FE9A478EEF6D720CCD56AA30C91AEAB787D "点击放大")