Data Structures and Algorithms

    

Code Comments: How to Properly Comment Code

Authors: Mason White

A good codebase is a well-documented codebase. Many scientific programs are being developed by scientists as opposed to formally trained developers. As such, the need for scientists to know how to properly document code is growing. A well-documented codebase allows scientists to write better, easy to understand code that will ultimately free up resources that can be allocated for more productive tasks such as conducting their research as opposed to spending countless hours trying to modify a codebase that needs to meet new requirements. This document will give a brief tutorial on how to properly write code comments as well as API-level documentation that will make scientific software easier to understand and much more modifiable in the future.

Comments: 6 Pages.

Download: PDF

Submission history

[v1] 2022-01-10 12:07:02

Unique-IP document downloads: 301 times

Vixra.org is a pre-print repository rather than a journal. Articles hosted may not yet have been verified by peer-review and should be treated as preliminary. In particular, anything that appears to include financial or legal advice or proposed medical treatments should be treated with due caution. Vixra.org will not be responsible for any consequences of actions that result from any form of use of any documents on this website.

Add your own feedback and questions here:
You are equally welcome to be positive or negative about any paper but please be polite. If you are being critical you must mention at least one specific error, otherwise your comment will be deleted as unhelpful.

comments powered by Disqus