README

--- README 编写得不好，现在不是重点...

规则

类必须标注 @endpoint 和 @name

/**

@entrypoint
@name DocTestClassApi
*/
@entrypoint 表示类是否为入口点
@name 表示资源的名称

每个合适的类必须在必要的方法上标注注解，例如

/**
 * @endpoint
 * @name umnomeaqui
 * @description Manda a carroça para algum lugar
 * @method GET
 * @expected {"arg1": "","arg2":"","arg3":""}
 * @field $arg1=decricao do campo
 * @field $arg2=descricao do campo
 * @optfield $arg3=descricao do campo
 * @rule $arg1=deve ser uma string
 * @rule $arg2=deve ser um inteito de 0 a 10
 * @optrule nome=true para pinda, false para monhangaba
 * @obs Para que o recurso funcione é necessário que use o PHP
 * @example {"arg1": "Carroça","arg2":5,"arg3":true}
 * @return {"A carroça foi 5 vezes para pinda"}
 */
public function func1($arg1, $arg2, $arg3=false)
{
	return $arg1 + $arg2;
}

要使用它，请按照以下步骤操作
创建主要对象
$api = new FrobouDocApi();
搜索一个标注过的类
$obj = $api->getClassDoc(DocTestClassApi::class);
根据需要以任何方式使用结果数组。

一个想法是创建一个 @teste 注解 teste=(valor1=valor,valor2=valor) 并根据需要解析
想象力是无限的

frobou / frobou-doc-go

维护者

详细信息

README