簡體   English   中英

如何為方法和屬性自定義NetBeans PHP自動DocBlock?

[英]How do I customize NetBeans PHP auto DocBlock for methods and attributes?

創建方法后,我使用/**<enter>生成DocBlock。 它會自動填充該函數的@param@return 例:

/**
 *
 * @param type $str
 * @return type 
 */
public function strlen($str){
    return strlen($str);
}

如何自定義生成的塊,以便它也填充@author並在/**<enter>之后結束

/**
 *
 * @param type $str
 * @return type 
 * @author John Doe <john@doe.com>
 */
public function strlen($str){
    return strlen($str);
}

謝謝

可能有更好的方法來實現這一點,但這就是我所使用的:在工具>選項>編輯器>代碼模板下,有一些預定義的組合可以快速生成代碼。 7.0中的默認模板之一是:

vdoc<tab>

這會生成偽文檔塊和變量定義。 您可以替換它並添加擴展為您想要的任何文本的新文本,就像vim縮寫一樣。 您可以在Netbeans文檔站點上找到更多相關信息:

http://netbeans.org/kb/docs/php/code-templates.html#using-templates

我相信你正在尋找的答案將在這里找到: phpDocumentor Tutorial

我想你會想看--customtags命令行開關。

所以最有可能的是,當你進入工具 - >選項 - >“PHP” - >“PHPDoc”時,可以將--customtags命令行開關添加到PHPDoc腳本行中。

我個人沒有嘗試過這個,但我一直在嘗試將NetBeans與DocBlocks和PHPDocumentor結合使用,以“自動”創建大量可用的文檔,而不會對其他編碼人員過於費勁 ;-)

這里有一個關於設置NetBeans以使用PHPDocumentor的精彩視頻教程: 使用NetBeans IDE 7.0生成PHP文檔

要啟用正確的@author標記自動完成,只需轉到:工具 - >模板 - > PHP-> PHP類,按“設置”按鈕並取消注釋以#user #user=開頭的行。 現在您可以編輯名稱和電子郵件,這些名稱和電子郵件將傳遞給您的班級評論。

來自各種來源的簡短回答:不,你不能編輯可以為你添加它的模板。

  1. 如果您仍在尋找相同的功能,可以創建一個 ,然后將其綁定到快捷方式(例如“Alt + W”)。

要創建 :工具 - >選項 - >編輯器 - >宏

示例:

Alt+W => insert-break "/**" insert-break

這個宏有助於用左手添加PHPDoc,這使得它更快。 您可以使用此宏生成您想要生成的任何內容,然后將光標放在正確的位置,然后在注釋的末尾添加@author YOUR_NAME。


  1. 您還可以通過以下方式設置項目的一般作者:工具 - >模板; 點擊“設置”

添加行:

user=YOUR NAME <email.prefix at domain.extension>

這會將@author添加到所有新的類/接口定義中。

我希望這能幫到您!

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM