Нужны ли строки документации в wordpress?
/**
* 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 ) {
Я нашел эти строки документации поверх функции в "functions.php" моего веб-сайта Wordpress. Во-первых, они называются «строками документации»? Во-вторых, устранение этого не вызывает каких-либо проблем в работе. Пожалуйста, объясните его важность. Я не нашел ресурсов, отвечающих на мой вопрос.
Ответы 1
Вы имеете в виду блоки DocBlocks, которые являются частью стандартов документации PHP WordPress: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/
Вы можете узнать больше о системе, на которой она основана здесь: https://phpdoc.org/
Короче говоря, это стандартизированная форма документации по коду, которую можно интерпретировать и использовать разными способами. Например, ваша IDE может отображать эту информацию как часть своего intellisense.
Secondly, does removing this cause any issue in the functioning.
Удаление DocBlocks не должно приводить к поломке чего-либо, но я не вижу веской причины для этого.