一套基于Android Lint的代码检阅规则,用于对指定注解的代码进行提示和建议
Whisper 是一套针对注解的代码检阅规则,作用于Android静态代码扫描,可以给开发人员在编写代码时提供代码提示和修改建议。Whisper 基于 Lint 开发,Lint 天然集成在 Android Studio 等IDE中,IDE 可以对命中规则的代码进行UI提示。
Whisper 具有多种注解,每种注解有不同的提示作用——
@NeedInfo
不要误以为自己能写出“自解释”的代码!充足的注释和文档可以使代码维护变得更简单。
NeedInfo
注解提供了一种给代码 “强提示” 的效果。@NeedInfo
注解的目标可以是变量、方法或者方法参数,IDE会对方法、属性的使用方进行代码提示。 @NeedInfo
接受一个字符串参数,内容就是代码提示的内容。
例如,在方法 method1
上添加注解 @NeedInfo("千万不要修