DEV Community

Discussion on: Self Documenting code isn't

Collapse
zebmason profile image
zebmason

ASCII art is a good use of comments, e.g. drawing a hidden-line diagram of a cube with the corner and mid-side node numbers since for FEA programs there are at least 3 different conventions. Typically this will be for processing by Doxygen.