我想开始正确地记录我的代码,但我不确定将它放在哪里最好让 HeaderDoc 阅读。我在 HeaderDoc 文档中阅读了以下短语,这让我认为预期的位置(从 Apple 的角度来看)在头文件中?
如果您愿意,您可以指定一个输入目录,而不是指定单个输入文件(如上所述)。HeaderDoc 将处理输入目录(及其所有子目录)中的每个 .h 文件,为每个包含 HeaderDoc 注释的标题生成 HTML 文件的输出目录。
这是正确的吗?我放置文档的位置会有所不同吗?
我想开始正确地记录我的代码,但我不确定将它放在哪里最好让 HeaderDoc 阅读。我在 HeaderDoc 文档中阅读了以下短语,这让我认为预期的位置(从 Apple 的角度来看)在头文件中?
如果您愿意,您可以指定一个输入目录,而不是指定单个输入文件(如上所述)。HeaderDoc 将处理输入目录(及其所有子目录)中的每个 .h 文件,为每个包含 HeaderDoc 注释的标题生成 HTML 文件的输出目录。
这是正确的吗?我放置文档的位置会有所不同吗?