In a similar vein, Taylor Otwell from Laravel writes his comment blocks exactly three lines long and each line is three characters shorter than the line above, e.g.
/*
|--------------------------------------------------------------------------
| Application Name
|--------------------------------------------------------------------------
|
| This value is the name of your application, which will be used when the
| framework needs to place the application's name in a notification or
| other UI elements where an application name needs to be displayed.
|
*/
The good thing about this is that it forces you to think about what to write. The bad thing is that it doesn't force you to think about how to write it so it's easy to read and understand, just so it's exactly the right length...
comment by him on a podcast [1]: "Started doing the 3-line comments just for visual appeal, became an iconic part of Laravel over time. And then I just kept rolling with it, and it became like a a [sic] Laravel meme of sorts."
