ExportXMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Major - P3
    • 9.1.0-rc0, 9.1.0-rc1024
    • Affects Version/s: None
    • Component/s: None
    • None
    • Server Programmability
    • Fully Compatible
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      There's an ad hoc (optional) convention of clarifying some call arguments with comments giving the parameter name.

      There's now an emerging standard notation for this particular pseudosyntax:

          copy(/*length=*/n, /*pos=*/startPoint);

      There's a clang-tidy checker for this, that we could enable after cleaning up the codebase to conform to this convention. But we understandably have many inconsistent formats for these comments, and those will need to be "fixed".

      https://clang.llvm.org/extra/clang-tidy/checks/bugprone/argument-comment.html

      Obviously these comments, when present, gain a ton of utility when a tool actually checks that the called function agrees with the caller's notion of what the parameter name is!

            Assignee:
            Mathias Stearn
            Reporter:
            Billy Donahue
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: