Examples For Good Inline Source Code Documentation

Question

[Hranjeev]

In order to enhance learning any new programming language perhaps its a good idea to learn from a project's source code which is well-documented.

I wonder wether any open source bioinformatics projects has such good inline documentation that we can read and see how those great minds make code. I would appreciate any mathematics algorithm implementations too that can be loosely related to bioinformatics. I have seen a few but rather poorly documented.

Where is the best place to look for these kind of documentation and how. If anyone has any sources kindly share. Thank you.

[Neilfws]

A good question. Given that good documentation is rare for bioinformatics code, it will be interesting to see if anyone knows any good examples.

Answer 1

[brentp]

There is a lot of good stuff in biopython. The FASTQ quality stuff is especially informative.