wordpress 中的文档字符串有什么用吗?
Are docstrings in wordpress of any use?
/**
* Retrieves the post excerpt.
*
* @since 0.71
* @since 4.5.0 Introduced the `$post` parameter.
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
* @return string Post excerpt.
*/
function get_content_excerpt( $post = null ) {
我在我的 Wordpress 网站的“functions.php”中的一个函数之上找到了这些文档字符串。首先,这些被称为“文档字符串”吗?其次,删除它是否会导致功能出现任何问题。
请说明其重要性。我没有找到可以回答我问题的资源。
您指的是 DocBlocks 并且是 WordPress PHP 文档标准的一部分:https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/
您可以在此处阅读有关它所基于的系统的更多信息:https://phpdoc.org/
简而言之,它们是一种标准化形式的代码文档,可以通过多种方式进行解释和使用。例如,您的 IDE 可能能够显示该信息作为其智能感知的一部分。
Secondly, does removing this cause any issue in the functioning.
删除 DocBlock 应该不会导致任何破坏,但我看不出这样做的正当理由。
/**
* Retrieves the post excerpt.
*
* @since 0.71
* @since 4.5.0 Introduced the `$post` parameter.
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
* @return string Post excerpt.
*/
function get_content_excerpt( $post = null ) {
我在我的 Wordpress 网站的“functions.php”中的一个函数之上找到了这些文档字符串。首先,这些被称为“文档字符串”吗?其次,删除它是否会导致功能出现任何问题。 请说明其重要性。我没有找到可以回答我问题的资源。
您指的是 DocBlocks 并且是 WordPress PHP 文档标准的一部分:https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/
您可以在此处阅读有关它所基于的系统的更多信息:https://phpdoc.org/
简而言之,它们是一种标准化形式的代码文档,可以通过多种方式进行解释和使用。例如,您的 IDE 可能能够显示该信息作为其智能感知的一部分。
Secondly, does removing this cause any issue in the functioning.
删除 DocBlock 应该不会导致任何破坏,但我看不出这样做的正当理由。