I'm looking through the source code of the latest OSQA release, and internal documentation is nowhere to be found. How do you develop and maintain such a large and widely used open-source project without inserting almost a single line of comments into the code?

asked 30 Oct '11, 19:48

kpozin's gravatar image

kpozin
31112
accept rate: 0%


It's true that the biggest part of the code is not documented, however we are making efforts to document the more complicated parts of the source, especially during the process of implementation. However one of the things I love about Django is that it's code is self-documenting and easy to understand, even without comments everywhere. I believe that the OSQA source is really well structured and easy to maintain, especially when using a nice IDE.

link

answered 31 Oct '11, 12:09

Jordan's gravatar image

Jordan ♦♦
3.1k618
accept rate: 39%

Your answer
toggle preview

Follow this question

By Email:

Once you sign in you will be able to subscribe for any updates here

By RSS:

Answers

Answers and Comments

Markdown Basics

  • *italic* or _italic_
  • **bold** or __bold__
  • link:[text](http://url.com/ "title")
  • image?![alt text](/path/img.jpg "title")
  • numbered list: 1. Foo 2. Bar
  • to add a line break simply add two spaces to where you would like the new line to be.
  • basic HTML tags are also supported

Tags:

×298
×17

Asked: 30 Oct '11, 19:48

Seen: 808 times

Last updated: 31 Oct '11, 12:09

powered by OSQA