2016-11-24 105 views
4

我如何格式化return語句,以便它也對齊到同一水平的參數說明(參見下圖) enter image description hereIntelliJ IDEA的格式的JavaDoc

我想擁有的第二線至少與第一行對齊的語句return,在這種情況下,needed字應與Some字對齊。我試過全部設置在Settings -> Editor -> Code Style -> Java -> Tab "JavaDoc",但沒有找到return的任何設置。這是所需輸出的片段:

/** 
* Add 2 to x and multiplies the result with y. 
* 
* @param x X param. 
* @param y Y param 
* 
* @return Some very long return description of the return statement even if it sometimes does not make sense but is 
*   needed to show the purpose of my question. 

正如您所看到的「所需」正好低於「某些」。

+0

請將代碼粘貼到所需的格式,請....我不明白它是如何看起來像 –

+0

我認爲這個想法是,大多數情況下,返回值的描述應該很短。有關它的更多細節應該在方法描述中。在極少數情況下,如果您有多行退貨說明,則可以手動縮進後續行。 –

回答

1

看起來好像IntelliJ 沒有有定製選項來指定@return標記描述的縮進樣式。但是,此鏈接顯示此問題已在IntelliJ中確定,並且是listed as a feature to be implemented in their backlog。從一個開發者的注意事項:

雅羅斯拉夫Lepenkin 2016年7月14日,03:12 - 目前它不是優先 名單,但我想我會拿出一些增強功能2016.3

它在2014年被作爲問題提出,問題狀態最近從「待討論」變爲「開放」,所以希望它能在下一個版本中實施。

現在,雖然這不是最好的解決方案,但您可以縮進每行描述並使用Ctrl + Alt + L來調整評論環繞。

+1

感謝您提供鏈接! –