Version Control Documenting Aide

Jclifton44 · 2019-01-20 03:09:00

Hello,

Are there any packages out there to help document and comment projects you may be working on?

For example, a utility to add a header to every code file in a project or a utility that adds function headers, inputs, and outputs.

Jeremy

Trilby · 2019-01-20 03:58:28

What does this have to do with version control?

What exactly do you want it to do? It sounds like you want the tool to write your comments for you - if this were possible, comments would serve no purpose. You need to provide information to others who would read your code.

If in contrast, you are looking for standardized comment format and a way of turning comments into documentation, there are several options depending on the language:
https://en.wikipedia.org/wiki/Doxygen
https://wiki.python.org/moin/DocUtils
https://en.wikipedia.org/wiki/Literate_programming

Jclifton44 · 2019-01-20 04:32:01

A program that wrote useful comments would not be bad.

I was thinking that code smells in the diffs could be iteratively viewed and comments could be added at the programmer's discretion.
As an example:

MOV R1 X

has been changed to 

MOV R1 Y

Would you like to comment?

(y/n)

Last edited by Jclifton44 (2019-01-20 04:36:22)

seth · 2019-01-20 08:52:06

I assume he wants to be walked through "git diff" while "git commit", but that sounds like rahther specific (and in this case ASM related) - single feature commits can easily cover hundreds of LOC, imagine you'd be asked for each

Arch Linux

#1 2019-01-20 03:09:00

Version Control Documenting Aide

#2 2019-01-20 03:58:28

Re: Version Control Documenting Aide

#3 2019-01-20 04:32:01

Re: Version Control Documenting Aide

#4 2019-01-20 08:52:06

Re: Version Control Documenting Aide

Board footer