Comments are a vital part of making code readable, but they’re more than just documentation. They’re communication between one developer and another. They tell us what the code does, but also how we feel about it.
Scott found this, which conveys a most fervent hope for this block of code:
catch(Exception ex) { // Please don't crash }
Perhaps Martin's co-worker was proud of solving such a difficult problem:
/** * Please be carefull when modifying this function. This is really advanced code. * @return bool */ public static function initResources() { return true; }
I hope Francesco appreciated this note, full of vulnerability and honesty:
if (type == "radio") { // Too much complex to validate }
And some comments are nothing but a warning to others:
</tbody></table> <!-- DON'T TOUCH THE LINE BELOW !!! --> <!-- INFERNO --> </form>
[Advertisement]
BuildMaster allows you to create a self-service release management platform that allows different teams to manage their applications. Explore how!