Literate-Source-Code | An Alternative Way

Literate-Source-Code is a JavaScript library. Literate-Source-Code has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can download it from GitHub.

To document single source code units files can be a daunting task — at least it has been for me. On the one hand there are well established ( strict ) standards following for example the DocBlock Guidelines, such as Javadoc Comment, PHPDoc et al., and on the other side of the spectrum there is no software documentation at all — the latter not being the choice of the day. The question to be answered is what, how ( much ) and to whom exactly a project wants to deliver documentation-wise. Is there possibly a KISS all-encompassing way to satisfactorily address all stakeholders? Maybe ... LSC ( Literate Source Code ) might be a good concept to implement. It is flexible enough to mimic — literally to the dot — the strict way as well as to accommodate a very informal and / or minimalistic writing style.