php [php：phpDOC] DOCコメント的例句。どこから拾ってきたんだったか... #php

Posted 2021-05-05

/**
 * Class: Class name
 *
 * Lorem Ipsum is simply dummy text,
 * Of the printing and typesetting industry. 
 *
 * @access public | private
 * @author [e-mail]
 * @copyright  hoge All Rights Reserved
 * @category EntityName | CRUD | Ajax ...etc
 * @package Controller | Model | View
 * @var class ClassName $PropertyName
 * @var int propertyName $propertyName
 */

   
/**
 * Method: methodName
 *
 * Lorem Ipsum is simply dummy text,
 * Of the printing and typesetting industry. 
 *
 * @access public | protected | private
 * @param array $sender
 * @param array $params
 * @return integer $messageId 
 * @throws NotFoundException 
 * @see MessageApi::paramCheck | http://hogehoge.com
 * @todo Too fat logic !!
 */