How to indent documentation in appledoc/HeaderDoc（关于带参数的块的文档）

Question

我创建了一个将块作为参数的方法。该块需要一些参数，所以我想缩进文档，就像 Apple 在其具有类似格式的方法中所做的那样...

代码中的一个简单示例是：

/** Loads a project from web service.
 @param securityKey The security key.
 @param block The block to execute after the web service returned all data. The block takes five arguments:
     @param data The data.
     @param fields Some fields.
*/
- (void)loadProjectWithSecurityKey:(NSString *)securityKey andCompletion:(void(^)(NSDictionary *data, NSDictionary *fields))completion;

但很明显，这只会在文档中出现：

我如何让 data 和 fields 像 Apple 的方法那样缩进显示？

我在 Apple's documentation on HeaderDoc

中找不到如何执行此操作

Answer 1

您可以使用：

@param block My block with the following parameters: 
<table>
<tr>
  <td><tt>myParam</tt></td>
  <td>Description</td>
</tr>
</table>

How to indent documentation in appledoc/HeaderDoc（关于带参数的块的文档）

How to indent documentation in appledoc/HeaderDoc (for documentation on blocks that take arguements)

objective-c

ios

headerdoc

appledoc

swift