Document Specifics of Filesystem Paths [DI34] [WHAT]
Tip DI34
A filesystem “path” could refer to many different things. It’s usually best to be specific about the kind of path in variable names themselves. However, when that is not possible, make sure to document specifics of filesystem paths so that other programmers will know what kinds of paths are expected.
For example, if a member variable can support a wide variety of paths, making that clear in the documentation gives other programmers confidence in using the variable correctly:
