草庐IT

ios - How to indent documentation in appledoc/HeaderDoc(关于带参数的 block 的文档)

coder 2023-09-10 原文

我创建了一个将 block 作为参数的方法。该 block 需要一些参数,所以我想缩进文档,就像 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;

但显然这只会出现在文档中:

如何让 datafields 像 Apple 的方法一样缩进显示?

我在 Apple's documentation on HeaderDoc 中找不到如何执行此操作

最佳答案

您可以使用:

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

关于ios - How to indent documentation in appledoc/HeaderDoc(关于带参数的 block 的文档),我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/28507180/

有关ios - How to indent documentation in appledoc/HeaderDoc(关于带参数的 block 的文档)的更多相关文章

随机推荐