attaboy

joined 1 year ago
[โ€“] attaboy@lemmygrad.ml 1 points 1 year ago

I assume with "close" they meant that documentation should be located right there at the code it is documenting. Think Java doc comments (heredoc) or how in Golang you put comments above a function definition which is then automatically turned into documentation.

If documentation is located in an entirely different file, it's easy to modify code and forget to update the corresponding documentation.

[โ€“] attaboy@lemmygrad.ml 3 points 1 year ago (1 children)

Whatever you do, just don't ever use GoDaddy.