如何解决枚举数组值可用选项的javadoc约定是什么?
如果我有一个接受某些选项作为数组参数的方法(在我的情况下,这是在PHP中),让我们这样说:
public static function my_function(array $options=[]): void {}
让我们说$options
只能识别两个(布尔)值'cache'
和'output_html'
。
因此,可以接受以下任何一种呼叫方式:
my_function(['cache' => true]);
my_function(['cache' => false,'output_html' => true]);
my_function();
当然,在数组中设置任何其他键仍将“起作用”,但不是公认的选项。
我如何在Javadoc注释中指出这些是$options
参数的(唯一)可识别/相关的数组选项?
/**
* Outputs some great data from the database,optionally caches it,* can output HTML or raw string.
* [@param array $options (????) ]
* @return void
*/
(显然,在此特定示例中,将这两个选项作为单独的bool
参数列出可能会更可取,但这只是关于数组参数的一般问题,通常不仅仅接受两个参数选项)。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。