有代码的文件的配置注释是否有任何标准格式?

时间:2014-08-14 10:20:48

标签: file comments

我需要将一些信息传递给文件并稍后解析它。

WordPress (php)就像:

<?php 
    /*
    Template Name: My template
    */
?>

但是我需要传递更复杂的数据,例如:

    /*
     * @param name : "Some name" | type : "int" | default : 3 | Description goes here
     * @param name : "Another name" | type : "int" | default : 3 | Description goes here
     * @param name : "Bla name" | type : "int" | default : 3 | Description goes here
     *
     */

目标必须是可读的,并且由非技术人员轻松修改

我在这里寻找一些标准,但我没找到任何标准。我正在检查一些功能文档标准,如

/**
 * Display a variable's contents using nice HTML formatting and will
 * properly display the value of booleans as true or false
 *
 * @see var_dump_plain()
 *
 * @param  mixed $var The variable to dump
 * @return string
 */
public static function var_dump( $var, $return = FALSE ) {
    //
}

但它缺少一些我需要传递给每个@param的其他字段(例如读取名称默认值

0 个答案:

没有答案