PureChat / PureChat

The main repository for future releases and development.
Mozilla Public License 2.0
2 stars 0 forks source link

DocBlocks #2

Open ghost opened 10 years ago

ghost commented 10 years ago

Should we use DocBlocks or not? I used to like them a lot, and I can see where it's handy to use them for automatic documentation, but on the other hand, they take up so much space, it feels like unnecessary clutter to me now. I dunno. A file that would ordinarily be pretty short suddenly becomes quite long, with a minimum of four extra lines before every instance variable and method. Which style do you prefer?

Message class with documentation: https://gist.github.com/The-Craw/7275935

Message class without documentation: https://gist.github.com/The-Craw/7275988

ghost commented 10 years ago

Also, before anybody gets worried, that's the only code written for PureChat thus far, other than unit tests of course.