ApexDoc — Basic Comment Format

同学们，今天咱们来说说ApexDoc注释，这是Salesforce里用来给代码自动生成文档的一种特殊写法。 它跟普通的Apex注释最大的区别就在开头：普通块注释是用斜杠加一个星号，也就是 `/*`，而ApexDoc注释呢，是斜杠加两个星号——`/，`。多了这一颗星，解析工具才知道“哦，这是文档注释，我得把它提取出来”。 写的时候还有几条小规矩：这条注释要紧紧贴在它要说明的代码元素前面，比如类、接口、枚举、方法、构造器，或者属性声明的上方。如果注释内容不止一行，那么从第二行开始，每一行前面都要先写一个星号`*`，让它看起来整齐排列。你放心，生成文档的工具很聪明，它会自动忽略每行开头的那个星号和多余空格，只把里面的文字挑出来用。 注释里的第一段文字就是主要描述，必须用一句简洁的总结开头，并且这句话要以句号结尾。在这句总结之后，你可以在同一个段落里继续写一些补充说明，提供更多上下文信息。 简单总结就是：用`/，`开头、紧挨声明、续行加星号、第一句总结写完整并带句号。这样写出来的注释就能被ApexDoc工具正确识别，生成漂亮的文档啦。好了，这部分规则其实很直白，大家记住这几点就够了。