Skip to Main Content

Code Sharing

Code sharing for openness, reproducibility, and learning

The Grand Unified System of Documentation

Using comments well

Comments should be concise and updated. Leaving comments out of place, outdated, or redundant makes the code harder to read. Likewise, don't leave "commented-out" code in. Once it's replaced, use version control to document the change and delete the old code. Leaving commented-out code in, again, can confuse readers and make it unclear what is supposed to be run.