Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Isn't this a pretty generally accepted pattern? Java and Python use a similar format for their docstrings.


It's okay-ish if you need to document that actually needs documenting, but if you use docstrings for typing/IDE assistance people will document every single thing for that, leading to useless "documentation" like in my previous comment.

That said, I personally prefer just a paragraph or two of prose over "structured" formats.


Agree, I like to see at least an example value in the Docblock




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: