3 ms·
At a minimum, unless it is a trivial piece of code (like a few lines), you should comment about the purpose of a function and usage. Here is an example of how
by AlexeyBrin 10y ago
At a minimum, unless it is a trivial piece of code (like a few lines), you should comment about the purpose of a function and usage.
Here is an example of how the old school numerical analysts documented purpose and usage of their code (the short variable names are a historical artifact) http://www.netlib.org/lapack/explore-html/d0/db8/group__real_g_esolve_ga3b05fb3999b3d7351cb3101a1fd28e78.html#ga3b05fb3999b3d7351cb3101a1fd28e78 http://www.netlib.org/lapack/explore-html/d0/db8/group__real... For the more curious, this is a Fortran subroutine that solves a linear system of equations.