Reply To: Does anyone else get ASCII artistic in their code?

[__]

What @Alen is doing is JavaDoc (or PHPDoc, which is PHP’s version)-style comments.

Is’s a formalized syntax for code documentation. It can be parsed to auto-generate basic docs (many IDEs can read them, too). I’ve found it to be a great way to get myself to document my code.

When I need “section headings” in my code, I tend to borrow MarkDown syntax:

# HEADING #

##  Sub-Heading  ##

I used to do stuff like

/****************************
*          Hello!           *
* this is an important note *
*****************************
*      please read it       *
*  and know how cool I am   *
****************************/

…but it was honestly just too hard to maintain.