Code should not be documented #217
platipodium
started this conversation in
Standards: Documentation
Replies: 2 comments
-
Code should be readable by machines and humans alike. Code is documentation. Where this is not possible, annotations that explain the code are part of the code, targeting the human where the obscure only caters to the machine. |
Beta Was this translation helpful? Give feedback.
0 replies
-
Clean, modular, well-written code is a concern for all aspects of model reuse and interoperability but I'm not sure I understand what is being proposed here... I think OMF may eventually recommend that code meets domain-specific community standards, however those emerge.. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Code should be self-documenting as much as possible. Apt variable and function naming, explicit statements, short documentation only where functionality is obscured by code for exceptional reasons.
OMF as an organization should not delve into the code documentaiton but focus on model documentation (which could be in the code)
Beta Was this translation helpful? Give feedback.
All reactions