我知道我们可以使用
/// index variable
var i = 0
作为单个变量的文档注释。
我们如何为循环变量做同样的事情?
以下不起作用:
var array = [0]
/// index variable
for i in array.indices {
// ...
}
或
var array = [0]
for /** index variable */ i in array.indices {
// ...
}
背景:
我不使用“好的”变量名的原因是我正在实现一个使用数学符号导出的数值算法。在这种情况下,它只有单字母变量名。为了更好地了解推导和实现之间的联系,我使用了相同的变量名。
现在我想对代码中的变量进行注释。
最佳答案
使用 ///
主要是为了在 Swift 中记录类、结构等的 API。
因此,如果在类/结构中的 class
、func
、var
/let
之前使用,等等,您将文档附加到 Xcode 理解如何显示内联的代码方面。它不知道如何为函数内部的事物获取该信息,因为此时这不是 ///
的意图(它可能适用于简单的 var/let 但不太可能完全是故意的).
而是使用简单的 //
代码注释,以使任何在代码中工作的人受益,但要避免过度记录代码,因为好的代码很可能会向精通该语言的任何人 self 解释并添加不需要的文档会妨碍阅读代码。
这是目前 Swift 中代码文档的一个很好的引用 Swift Documentation
关于swift - Xcode 中循环变量的文档注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/56244801/