Doxygen: Как документировать константы PHP? - PullRequest
3 голосов
/ 29 августа 2011

Как документировать константы PHP:

define('SOME_CONSTANT', 'constant value');

с Doxygen?

Ответы [ 2 ]

3 голосов
/ 20 сентября 2012

Просто добавьте блок документации над вызовом функции define() или ключевым словом const, например:

<?php

/**
 * Short Break Adventure Trip Sub Type Id
 */ 
const TRIP_SBA = 1;

/** 
 * Small Group Adventure Trip Sub Type Id
 */ 
define('TRIP_SGA', 2);

?>
0 голосов
/ 26 июня 2012

Не уверен, что это то, что вы ищете, но вы можете использовать макрос Define

   \def <name>

Что-то вроде:

  /*!
    \def SOME_CONSTANT
    some constant documentation
  */
...