- The VENDOR must encourage the programmer working on an engagement to provide code comments so that a well documented source code is created.
- The code comments provided by the developers should mandatorily be neat, formatted, clean and readable as the basic minimum acceptable standard.
- The programmers should provide inline comments in a manner that it should compulsorily support readability of the code.
- In case of a descriptive blocks around functions and library files, the programmer must append a descriptive block above the declaration.
- The VENDOR must lay clear guidelines to its programmers with respect to creating pixel perfect design – the programer must be clear about the design issues he/she may be trying to overcome/hide with the comments.
- This is the necessary styling tips and best practices for code commenting –