為phpdoc添加sublime3的自定義塊引用

Question

我試圖這樣寫

{ "keys": ["ctrl+shift+;"], "command": { "characters": "/**@var*/", "block": true} }

但似乎完全沒有實現我最簡單的嘗試。

我想要快捷方式要做的是，一旦觸發，我希望輸入格式如下的文本

/**
  *@var
  */

有誰知道如何定義這樣的自定義快捷方式？

非常感謝你！

Answer 1

有兩種方法可以執行此操作，具體取決於所需的功能。 如果你想要的是打印你指出到底是什么，然后創建下面的代碼片段：

<snippet>
    <content><![CDATA[
/**
  * @var $0
  */
]]></content>
    <tabTrigger>vardoc</tabTrigger>
</snippet>

為此，請使用XML語法創建一個新文件，將其完全按照所示粘貼，然后將文件另存為Packages/User/vardoc.sublime-snippet ，其中Packages是您選擇Preferences -> Browse Packages時打開的目錄。 要觸發代碼段，請輸入vardoc並點擊Tab 。 您的光標將定位在代碼段中$0位置。

這應該可以正常工作，除非您需要輸入*如果需要換行，並且沒有任何聰明之處。 相反，我建議使用DocBlockr ，它是Sublime Text插件，可以自動生成多種語言（包括PHP）的文檔。 鍵入/**並點擊Tab或Enter將為您提供

/**
 * |
 */

凡| 是您的光標位置（我相信這也是內置的Sublime功能）。 它還可以自動記錄功能。 如果你有

function foo(MyClass $cls, 
            Array $arr, 
            $num=42, 
            $val=false, 
            $str="sweet function, dude!") {

    return $something;
}

然后將光標放在函數定義上方的行上，然后輸入/**並點擊Tab ，您將得到

/**
 * [foo description]
 * @param  MyClass $cls
 * @param  Array   $arr
 * @param  integer $num
 * @param  boolean $val
 * @param  string  $str
 * @return [type]
 */

突出顯示[foo description]因此您可以輸入自己的描述。 再次點擊Tab將隨后突出顯示MyClass ， Array等，因此您可以根據需要更改它們。

對於您的問題，您可以聲明一個變量

var $foobar = "I love unicorns";

將光標放在該聲明上方，然后輸入/** Tab將為您提供

/**
 * [$foobar description]
 * @var string
 */

DocBlockr還具有其他功能，請查看上面的鏈接以獲取更多詳細信息。

我希望這有幫助！