Documenting Parameters

no-email (Damien Seguy), Damien Seguy
Wed, 25 Oct 2023 00:00:00 +0000

Sometimes, even a literal value used as parameter is not readable. An easy way to document the literal values is to provide the name of the paramter. Since the parameters need a smart name to be used in the method, using it in the method call provides more context to the parameter.
Another option is to make that literal value a constant, and use that constant to provide a readable name.