DVPT01 Add comments to generated code from the description meta-attributes in the source model Such that code analysis tools, like those in OSOR.eu or ohloh.net do not present a negative observation because of the low percentage of language comments in the generated code. Arguably, this is not a defect of the generated applications, because the generated applications are documented way in excess to the usual maturity of hand-coded projects where the documentation is in-lined as code comments. Because the software development industry is geared towards expenditure in human resources, the hand-coding of comments inlined in the code is the most widely adopted practice to implementation documentation. Therefore, popular sites hosting services for the open-source collaborative develoment communities, include a documentation metrics algorithm that focuses only in comments in-lined in the code, and are unable to appreciate the existence of models in the product pages, semantically very superior to in-line comments for product documentation.
DVPT01 Add comments to generated code from the description meta-attributes in the source modelPermalink
Published on: 28/11/2009
Login or create an account to comment.