【问题标题】:Instructions for using the PHP manual (specifically regarding default Boolean values)使用 PHP 手册的说明(特别是关于默认布尔值)
【发布时间】:2018-02-26 19:27:19
【问题描述】:

我正在编写一些使用 cURL 的脚本,对是否需要显式设置各种选项或是否默认设置感兴趣,因此提出了http://php.net/manual/en/function.curl-setopt.php。通常手动会明确说明给定选项的默认值是 true 还是 false,虽然 curl_setopt() 对其中许多人这样做,但对其他人却不这样做。

该手册似乎通过以粗体输入来传达默认值,但由于我从未读过该手册使用此约定,因此我开始搜索它并惊讶地发现要么没有关于如何使用的说明使用手册或它们很难找到。

PHP 手册是否使用 bold 字体指示默认布尔值。是否有任何文档描述了本手册使用的这一约定和其他约定?

【问题讨论】:

  • 通过使用大写粗体手册表示PHP常量。
  • doc.php.net/tutorial 告诉如何创建文档
  • @aynber 我本来希望在那里,特别是在doc.php.net/tutorial/style.phpdoc.php.net/tutorial/faq.php,但事实并非如此。我能找到的最接近的是常见问题解答中的the <initializer> tag is used to signify the default value
  • @u_mulder 我不认为粗体大写字体仅用于常量。手动使用 TRUE 和 FALSE,以及 TRUE 和 FALSE
  • @user1032531 PHP 程序员应该能够识别这些内置名称,因此他们不应该被不一致的排版所迷惑。

标签: php conventions manual


【解决方案1】:

选项列表中间一栏的标题是value设置为。这意味着您应该假设该列中指定的值不是 默认值,它告诉您需要显式提供什么值才能导致选项描述中描述的行为。

在某些情况下,默认值取决于其他选项或 PHP 环境。这将在描述或备注列中提及。

【讨论】:

  • 感谢 Barmar,我还查看了 phpinfo 的输出以了解我的配置的默认值,但为 cURL 提供的内容不多。也许一些 cURL 特定的命令提供?你知道FAQ中“标签用来表示默认值”是什么意思吗?
  • phpinfo 只显示 php.ini 配置选项的值。大多数 curl 参数的默认值是硬编码的,不可配置的选项。关于<initializer> 的FAQ 是关于可选函数参数的。
猜你喜欢
  • 2013-07-05
  • 2011-10-08
  • 2020-12-03
  • 1970-01-01
  • 1970-01-01
  • 2012-07-20
  • 2018-05-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多