Regardless of side project or not I try to document the architecture using Kruchten 4+1 approach. It has helped me a lot to let others understand the big picture. For small projects I try not to describe the architecture too detailed.
Class and method docs can be automatically generated by different tools depending on language: sphinx, jsdoc, javadoc, doxygen, etc.
On the code level, i.e how to use this particular class or method, unit tests provide good examples on how to do that.
It's been forever since I used javadoc (or Java, outside of a few Android tweaks here and there), but I do recall it having the @example tag like JSDoc (not that you shouldn't be writing tests).
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
Regardless of side project or not I try to document the architecture using Kruchten 4+1 approach. It has helped me a lot to let others understand the big picture. For small projects I try not to describe the architecture too detailed.
Class and method docs can be automatically generated by different tools depending on language: sphinx, jsdoc, javadoc, doxygen, etc.
On the code level, i.e how to use this particular class or method, unit tests provide good examples on how to do that.
Oh, I didn't know the Kruchten 4+1 approach. Seems interesting, thanks!
It's been forever since I used javadoc (or Java, outside of a few Android tweaks here and there), but I do recall it having the @example tag like JSDoc (not that you shouldn't be writing tests).