WordPress.org

Ready to get started?Download WordPress

Forums

Them ubiquitous block-style comments (2 posts)

  1. alhadis
    Member
    Posted 4 years ago #

    Okay, this question is only peripherally WordPress related, but I thought to try asking here since I've no idea where else to ask... In a lot of source code, I see the same style block comments being used to delimit descriptions and stats:

    /**
    * WordPress
    *
    * Semantic Blog Publishing Platform
    *
    * @since 2003
    * @return string The kewlest blogging system in the world
    */

    There has to be logic between this. I remember hearing something about Ruby-on-Rails being responsible for the " * " line prefix and @name convention... but after extensive Googling, all I've gotten is a good deal of confusion.

    I've seen lots of languages and platforms use this to style documentation inside the code itself... WordPress is no exception. Somebody care to shed light on this, please?

    And if I don't get a reply here, I s'pose I can always spam Mr. Mullenweg with an e-mail. xD

  2. Ruby's not responsible for the * in the prefix. That's been around since Cobol.

    Start with WikiPedia: http://en.wikipedia.org/wiki/Comment_(computer_programming)

Topic Closed

This topic has been closed to new replies.

About this Topic