Documentation: Using Comment blocks in functions

[bms63]

Please select a category the issue is focused on?

Function Documentation

Let us know where something needs a refresh or put your idea here!

It could be advantageous for developers to have commented blocks of code for future developers making updates. These comment blocks could point out salient features of the code and/or give a more detailed explanation of how the code works/processes. This would be seen by developers or by users inspecting the code on github.

We would like to establish a common way to use these comment blocks in our code.

DoD:
Programming strategy has recommended best practice for using comments blocks in code.

@sgorm123 Does this capture our discussion yesterday?

[bundfussr]

@bms63 , @sgorm123 , I am not sure what you have discussed. I have added a "Comments" section in the programming strategy (see linked PR).
Could you have a look?

[bms63]

We never had a final decision on comment blocks. I will look over PR - thanks for taking this on.

[bundfussr]

@bms63 , should we remove the "release Q4" label? Or do you think we have an agreement until next week?

[bms63]

I think we can get this one resolved next week??

[bundfussr]

Maybe, let's try.