XiangkunYe / Tensorflow-Application-Generator

4 stars 4 forks source link

Lack of comments #1

Open zorzonp opened 5 years ago

zorzonp commented 5 years ago

As someone who doesn't know Python the greatest or much about neural networks it is hard, if not impossible to tell what is going on in their code. Most files are completely without comments, and the files that do have comments are not really descriptive enough. Each function/ class should have a comment describing what it is going, what parameters it takes oin and what it returns. Each file should also have a general comment describing the complete contents and the files purpose. In addition there should be more general comments describing what is going on. From a maintenance perspective big projects need comments especially when multiple people are working on them and when you might not be the person doing maintenance on the files.