J
J
JohnxFFF2019-12-05 10:27:50
PHP
JohnxFFF, 2019-12-05 10:27:50

How to document the code if you have added your own functionality?

Good afternoon, I took the module as a basis, redesigned it, added my own methods and a couple of variables.
Also, there were dependent classes that just needed to add 1 variable and change the namespace.
How to sign such classes?
Add yourself as 2 authors, or just write in the description Based on ?

Answer the question

In order to leave comments, you need to log in

1 answer(s)
K
Kirill Gorelov, 2019-12-05
@JohnxFFF

I think you have several options
. First. Just describe what he did, where he got it from.
Second, describe everything completely from scratch, as if you made a new product.
And the third. Describe in detail the module that you have redesigned and make a note to it that you have changed dependent classes.
How to proceed depends on the situation, who will read your documentation and how often you will refer to it. And what an important product you have made.
For myself, I would choose the first option. If for a small firm, then I would choose the third one. I think the best third.
The second option is if everything is very strict and there is a lot of bureaucracy.
I just write documentation all the time myself. And I get out of the situation.
That is, everywhere you need a golden mean and the ability to maneuver the situation.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question