Swiftlint: valid_docs 规则中的假阴性

创建于 2016-08-08  ·  3评论  ·  资料来源: realm/SwiftLint

当我覆盖协议实现时，我倾向于添加MARK:注释，如下所示：

class SomeLayoutAttributes: UICollectionViewLayoutAttributes {
    /// MARK: - NSCopying
    override func copyWithZone(zone: NSZone) -> AnyObject {
    }
}

目前，这给了我一个 Valid Docs Violation。 我会说这是一个假阴性。 向规则添加逻辑以便它不会触发包含MARK但不是有效文档的文档是否有意义？

picture larslockefeer

最有用的评论

嘿拉尔斯@larslockefeer ，
据我所知，三重斜杠用于描述下面声明的文档。

如果你会使用双正斜杠 MARK 你应该没问题。
例如// MARK: - NSCopying

picture freak4pc 于 2016-08-08
👍2

所有3条评论

嘿拉尔斯@larslockefeer ，
据我所知，三重斜杠用于描述下面声明的文档。

如果你会使用双正斜杠 MARK 你应该没问题。
例如// MARK: - NSCopying

freak4pc picture freak4pc 于 2016-08-08
👍2

@freak4pc的建议是正确的。 MARK 样式的注释应该是双斜线，而不是三斜线。

jpsim picture jpsim 于 2016-08-21

感谢@freak4pc的推荐！

larslockefeer picture larslockefeer 于 2016-08-22
👍1
此页面是否有帮助？
0 / 5 - 0 等级

相关问题

msanders picture msanders  ·  4评论
rajohns08 picture rajohns08  ·  3评论
castus picture castus  ·  3评论
bourquep picture bourquep  ·  3评论
mrtj picture mrtj  ·  3评论