webstrom的注釋

標籤：ram   webstrom   技術分享   web   log   需要   style   .com   src   

　　今天我們小組的新同學有一個BUG調不好,然後我就幫他調一下.在調試的過程中非常累,糾其原因還是他注釋寫的不完善.我們可以看一下,他是這樣寫注釋的(隨便拿一個方法舉例),如:

　　乍一看,是不是覺得他的注釋挺規範的,其實不然.我們在調用的這個方法的時候,並不會有提示.:

　　

　　然後我就問他,你為什麼不寫有提示的注釋呢?他很驚訝的告訴我他上家公司都是這樣寫的,並不知道注釋可以有提示,這也讓我意識到並不是所有的人都知道這事兒,然後也讓我下定決心把入職培訓給充分完善(當然,這是後話).

　　那麼接下來,我就簡單介紹一下webstrom的方法應該如何寫注釋:首先在方法名上方輸入/**,然後按下鍵盤的enter鍵,會出現的內容:

　　

　　我們可以非常清楚的看到@param和@returns分別代表參數和傳回值,所示我們需要在他們後面完成相應的補充說明即可.注意:補充說明寫在{}裡面.如所示:

　　

　　那麼接下來我們看我們在調用此函數的時候會有哪些變化,如所示:

　　

　　是不是我們在調用的時候會提示我們參數,傳回值的意義及類型.同樣的,寫完方法體,在寫參數的時候一樣會有說明,如所示:

　　

　　所以以後建議大家在使用webstrom寫注釋的時候都這麼寫.

webstrom的注釋