[TIMOB-9914] BlackBerry: Proper class comments missing
| GitHub Issue | n/a |
|---|---|
| Type | Bug |
| Priority | High |
| Status | Closed |
| Resolution | Fixed |
| Resolution Date | 2012-09-20T16:53:06.000+0000 |
| Affected Version/s | n/a |
| Fix Version/s | Sprint 2012-19 BB, BB Preview 3 |
| Components | BlackBerry |
| Labels | n/a |
| Reporter | Josh Roesslein |
| Assignee | Jean-Philippe Lemieux |
| Created | 2012-07-10T07:04:24.000+0000 |
| Updated | 2017-03-03T01:38:48.000+0000 |
Description
Code review identified that the level of class commenting was not sufficient.
We need to do a pass through the existing classes and ensure all of them have sufficient high-level description of the class purpose, its role in the hierarchy and its methods/properties.
This applies mainly to framework classes; and needs to be done before we can merge the work with the Appcelerator's main branch.
I think reviewing the comments for any classes or methods that are "core" to the platform would be a good idea. Anything that may not be so trivial to understand from just reading the code. Any background knowledge or "why you did it this way" would be very helpful.
Closing ticket as BlackBerry is no longer supported.