search

topjung3 / npr-android-app

Automatically exported from code.google.com/p/npr-android-app
0 stars 0 forks source link

Add code documentation #59

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
There are almost no code comments.  Anybody willing to volunteer to write 
function prolog's?

Original issue reported on code.google.com by white...@gmail.com on 4 Feb 2011 at 6:46

GoogleCodeExporter commented 9 years ago 
This is clearly a matter of style, but for my part I'd rather spend the effort 
making the code intentional and readable and providing test coverage than in 
adding comments. That said, there are no doubt numerous places in the code that 
could use some clarity and if, as you work through it, you see those places and 
can add clarity that would be a great boon to others.

Original comment by jeremy.w...@gmail.com on 4 Feb 2011 at 5:15

GoogleCodeExporter commented 9 years ago 
Documentation is always something I've wanted to add, but falls lower on my 
list of priorities than adding must-have features. I agree, it would make the 
code much simipler to have in-line comments.

Would a bird's eye view document be helpful? Even if it was something more like 
a flow chart in terms of how the app works?

Original comment by nprme...@gmail.com on 4 Feb 2011 at 5:28

GoogleCodeExporter commented 9 years ago 
Ah; like in all software projects...  documentation is important but never 
important enough...

An overview would probably be good thing!  It took me a long time to figure out 
the event flow of the app.  I can add some comments to functions as I touch 
them; unfortunately I'm a n00b so it might take a lot of review.

Original comment by white...@gmail.com on 5 Feb 2011 at 3:56

GoogleCodeExporter commented 9 years ago 
This would be great. Perhaps we can put it on the roadmap for the future.

Original comment by jpenn...@gmail.com on 19 May 2011 at 7:37