2016-11-24 195 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

感谢您提供链接! –