Better API documentation
Tiberriver256 opened this issue · 1 comments
Tiberriver256 commented
- Ensure every function parameter is has a description
- Ensure every function has at least 2 examples with description of what the code will do
- Ensure every function has a full description of what that function does
- Ensure every class has documentation
- Ensure every property and method on classes have documentation
Could we create our own PSScriptAnalyzer rule to keep track of this for us? Probably worth investigating if we can keep track of this automatically so our docs stay in-sync with our code changes moving forward.
Created from #135
TylerLeonhardt commented
I have one request:
Private functions only need a comment above them. Not the full comment-based help.
#157 fixes the first 3