3 ms·
I see where you're going, and I'm probably not as clear as I wanted to be (and probably don't have time to be!) The ruby community is interesting because of th
by mgkimsal 16y ago
I see where you're going, and I'm probably not as clear as I wanted to be (and probably don't have time to be!)
The ruby community is interesting because of the testing focus, which possibly negates my point a bit. However, I meet plenty of Rubyists who are so focused on tests (which are easy to do because of the language) that they eschew documentation, of any kind.
I've talked to more than a few Rubyists who are now in the 'my code is self-documenting because Ruby is so elegant and my method names and variables are so awesome and I can metaprogram anything I need that there's 0 need to have any comments or documentation - just read my code and the awesomeness of Ruby will overtake you'.
I don't particularly care how elegant your code is, having some inline comments will not hurt. Having external documentation, and sane commit log comments, and so on, are vital in my view. I'm not picking on Rubyists here specifically, that's just the few that spring to mind.
- raganwald 16y agoYou know what? I need a browser plugin that delays posting all comments until I've finished my second coffee. You make some good points, I suspect we agree on almost everything. In a way, good languages are interesting because they make good practices so easy they're invisible. Which makes me very interested in the question of documentation. Throwing tests out the window as documentation for the purposes of this discussion, how do you feel about DSLs as one form of self-documenting code?
- mgkimsal 16y agoNot opposed to them, and probably have some good points (javadoc/phpdoc is probably, at a stretch, an example of that. I've got to run now, but email me at mgkimsal@gmail.com to carry on :)