Standards for in-the-code documentation

ContextInstitute / bfcom

http://bfn.context.org

GNU General Public License v3.0

4 stars 1 forks source link

Standards for in-the-code documentation #118

Open rgilman opened 5 years ago

rgilman commented 5 years ago

Today I added some comments to bfc-functions.php to clarify the purpose and add references to the various functions in that file. That's a useful start but it got me wondering about what our standards and understanding should be for doing this kind of documentation.

Thoughts?

iangilman commented 5 years ago

The comments you added look good to me. I figure the best approach is to add comments as we feel they are needed and maybe over time a standard will evolve.