search

ossia / qml-remote

1 stars 1 forks source link

Code documentation #56

Closed jcelerier closed 3 years ago

jcelerier commented 3 years ago

There starts to be quite a lot of code. I think that it would be beneficial to have some documentation : for instance a few .md files that describe the overall architecture (it can be based on the existing report !) and some documentation blocks in source files for the most important classes.

In the doc to make it useful, describe the overall design (how classes fit together, etc) - that's the most helpful thing to have

Toine-ddt commented 3 years ago

I will work on it !

jcelerier commented 3 years ago

my recommendation is - don't spend time explicitely on it, but every time you work on a file, if the file is not documented spend a minute writing a couple lines of text at the top of the file about what the object defined in it is doing, what is it for, where / how it is visible in the software, etc..

Toine-ddt commented 3 years ago

ok