Почему я вижу так много комментариев в этом формате?

Question

Я вижу так много комментариев PHP в формате:

/**
 * (c) Copyright Someone 2009
 * legal crap
 * blorp
 */

Это просто условно, или есть причина? Я думал, что это просто так, как это делают некоторые люди, но теперь мне интересно, когда я обнаружил, что мой подсветчик синтаксиса делает это: Красный без звездочек http://img.skitch.com/20090628-ef9riek8m5d75udssrqewhkasn.png

Это происходит только тогда, когда я начал использовать этот формат, а затем прекратил его использовать. Почему комментарии делаются таким образом?

Answer 1

Это phpDocumentor комментариев. Комментарии, начинающиеся с /**, используются генераторами документации (по соглашению) для создания документации для проекта. Вот краткое руководство по для phpDocumentor .

Answer 2

Многие генераторы документации могут читать из таких форматов.

Это также используется многими IDE, чтобы помочь с кодированием. (например Zend Studio и другие)

/**
 * Title
 * 
 * @author Me
 * @copyright 2009
 * @name test
 * 
 * @param int $foo
 * @return bool 
 */
function test($foo)
{
    return is_int($foo);
}