File: BooleanParameter.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (7 lines) | stat: -rw-r--r-- 400 bytes parent folder | download
1
2
3
4
5
6
7
Providing parameter comments for boolean literals has some advantages:

*   Readability is generally improved, as the parameter name will likely provide
    some context on what the boolean literal means
*   [https://errorprone.info/bugpattern/ParameterName](ParameterName) checks at compile-time that the
    comments match the formal argument names to avoid accidentally transposing
    parameters