3 ms·
The less that is described by the signature, the more necessary it is to document a function. In C++/C#/Java, while the parameters and return values are often f
by mhaymo 13y ago
The less that is described by the signature, the more necessary it is to document a function. In C++/C#/Java, while the parameters and return values are often fairly obvious, exceptions are completely undocumented by the type system (unless you use Java checked exceptions, which you shouldn't), and so should be documented manually (and asserted in unit tests, to ensure the documentation doesn't become incorrect).