开发者

Doxygen: How to document PHP constants?

开发者 https://www.devze.com 2023-03-31 21:41 出处:网络
How to document PHP constants:开发者_如何学Go define(\'SOME_CONSTANT\', \'constant value\'); with Doxygen?Just include a documentation block above the constant define() function call or const keywo

How to document PHP constants:开发者_如何学Go

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

with Doxygen?


Just include a documentation block above the constant define() function call or const keyword like this:

<?php

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

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

?>


Not sure if it's what you are looking, but you can use the Define macro

   \def <name>

Something like:

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

精彩评论

暂无评论...
验证码 换一张
取 消