Documenting a Component

DEX601 - Unit 3 Documenting Components

📄 第 251 页 🎬 视频课程

课程章节介绍

今天我们来聊聊如何记录和增强你的Salesforce Lightning组件的文档。首先,Lightning框架有一个很酷的功能,就是它能自动帮你生成一些基本的代码文档。这就像是你写了一个故事,然后有人帮你自动生成了一个故事大纲。你可以通过访问一个特定的网址来查看这些自动生成的文档,这个网址通常是你的Salesforce域名后面加上`/auradocs/reference.app`,或者你也可以访问`https://.lightning.force.com/docs/component-library/`。 但是,自动生成的文档可能不够详细,这时候你就可以通过两种方式来增强它。第一种叫做“文档定义”(DocDef),这就像是给你的故事添加详细的章节和插图。你可以在这里提供组件的完整描述,包括它是做什么的,怎么用,甚至还可以放一些示例代码和解释。DocDef支持很多HTML标记,所以你可以用各种方式来美化你的文档。 第二种方式是“内联描述”,这就像是在故事的每一页下面加一个小注释。你只需要在组件的标签里添加一个描述属性,然后写上一两句话简单说明这个组件的作用就可以了。 通过这两种方式,你可以让你的组件文档更加丰富和易于理解,这样其他人使用你的组件时就会更加得心应手。希望这些信息对你有帮助,如果你有任何问题,随时问我哦!