はなぜPHPDOCのオープニングシーケンスは、単に `/ *`

Question

物事は非常に視覚的に見えると機械-parseablyこれについて何かを言う必要があるだけで/*

https://phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.htmlとの明確な、しかしdoesnの」 `/ **`の代わりに2つの星を持っていませんt。

あなたの考えは？

Answer 1

通常のPHPコメント（/* ... */）とDocBlock（/** ... */）（またはPHPDoc）の間に違いがあります。

PHP IDEを使用しているときには、両方のコメントがコメントとして解釈されます - DocBlocksを解析してより良いプログラミング体験を提供することができます（タイプヒントやオートコンプリートあり）。あなたのコード（パッケージ/クラス/関数/ etc）。

あなたは、たとえば、このコードを取る場合：

<?php 
/** 
    * A summary informing the user what the associated element does. 
    * 
    * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element 
    * and to provide some background information or textual references. 
    * 
    * @param string $myArgument With a *description* of this argument, these may also 
    * span multiple lines. 
    * 
    * @return void 
    */ 
    function myFunction($myArgument) 
    { 
    } 

あなたは機能myFunctionは何も（@return void）を返さないことを確認することができ、それが文字列のみのはずつのパラメータ（$myArgument）を受け入れます。

完全なドキュメントをエクスポートするには、phpDocumentor toolを使用します。