Comment by benbjohnson
16 years ago
I would love to see some way to relate test cases with sections of the README. That way you could see code coverage of your README. It's difficult to retroactively write a README after you've written your code but it can also be difficult to write all the code described by your README.
The README shouldn't hold every detail of your implementation but it would be a good starting point for developers trying to find where described functionality is located in a library.
Also, it would provide the inverse: You can see what test cases you have that are not described in your documentation.
Docco (and its variants) do sort of what you describe:
http://jashkenas.github.com/docco/
I can see its usefulness in documenting test cases.
That's awesome how it shows the comments and code side-by-side. The only downside is that I have to describe the functionality while I'm writing code instead of beforehand. Thanks, adorton.