ApexDoc — Block & Inline Tags

好，我们来看看这一页讲的是什么——Apex 里的文档注释标签，也就是我们写代码时用来生成文档的那些特殊标记。 你想象一下，当你在写一个方法时，为了让别人（也包括未来的自己）能快速看懂这个方法干嘛用的、参数是什么、返回值是什么，你就可以用这些标签来“标注”一下。这些标签都以 `@` 开头，所以也叫“块标签”。 首先，你得知道每个块标签都要单独占一行，放在方法描述之后。比如： - `@param`：用来描述方法的每一个参数。注意哦，有几个参数就得写几个 `@param`，而且顺序和名字必须严格跟你方法签名里的一致。 - `@return`：描述这个方法返回的是什么。 - `@throws`：描述可能抛出的异常。 - `@see`：用来做交叉引用，可以指向别的类、方法，或者一个文本说明，甚至一个 URL。 说完块标签，还有一种叫“内联标签”。它们不是单独一行，而是藏在描述文字里，用花括号 `{}` 包起来。常见的有： - `{@code}`：把里面的文字格式化成代码样式。 - `{@link}`：创建一个可点击的内联链接，直接跳转到别的地方。 - `{@literal}`：就是原样显示文本，不会去解析里面的特殊字符。 - 还有一个 `{@hidden}`，它很特别，可以让这一行在最终生成的文档里不显示出来，相当于“隐藏”了。 记起来很简单：块标签就是新起一行，说明参数、返回值啥的；内联标签就是嵌在描述里，做个小修饰或链接。这样你写出来的注释既规范，又能自动生成漂亮的文档。 好了，这一页的核心就是这些。下次写方法注释的时候，你可以试着用起来，会发现代码的可读性直线上升。