AS2Doc AS2Doc is a powerful, easy to use and fast documentation generator for your ActionScript 2 based classes. AS2Doc reads your source code, included comments and creates a rich content documentation automatically! You can choose various options to customize your documentation. Various output formats are supported by using AS2Doc Styles (XSL). You can even write [...]
Posts Tagged ‘Best Practice’
Documentation is a very important aspect in writing programs. Coders like to code; coders don’t like to write. It’s no secret that thorough and approachable documentation is a rarity in the coding world. Despite its necessity for the adoptability of a given software package, finding Sorry to say this folks, but employees leave. They get [...]
1. Don’t write deeply nested codeIt is bad programming style to write deeply nested code – the code has a tendency to drift across the page to the right and soon becomes unreadable. Try to limit most of your code to a maximum of two levels of indentation. This can be achieved by dividing the [...]
All we are a good programmer but we need to avoid thinking these points when we are writing code. It compiles, so it works. It works here, so it works everywhere. Commenting? We don’t have time to waste! UML diagrams are useless. Plan code so that we can reuse it is useless: we’ll end up [...]
Having been coding as a programmer, we have seen and write a lot of bad code. Code is not good just because it works. So here’s a quick list of that we would better keep in mind while coding. 1. Don’t sacrifice code maintainability to performance, unless it’s strictly necessary. This happens very often. You [...]