Examples For Good Inline Source Code Documentation
1
7
Entering edit mode
13.4 years ago
Hranjeev ★ 1.5k

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.

r java python • 3.0k views
ADD COMMENT
2
Entering edit mode

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

ADD REPLY
6
Entering edit mode
13.4 years ago
brentp 24k

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

ADD COMMENT

Login before adding your answer.

Traffic: 1771 users visited in the last hour
Help About
FAQ
Access RSS
API
Stats

Use of this site constitutes acceptance of our User Agreement and Privacy Policy.

Powered by the version 2.3.6