javadoc(或其他)注释的格式(行长度)

时间:2016-11-07 09:04:23

标签: comments commenting code-comments

是否有一个公约说明评论应该多长时间?

不同的线条长度不适用于任何显示器尺寸,甚至字体大小,阅读代码的其他协作者必须水平来回滚动才能读取整行。我想知道在人们与其他程序员合作的现实世界中这种类型的东西是如何解决的。或者是否有某种自动格式化程序,人们可以根据自己的喜好随时改变这种东西?

例如:

/**
 * Lorem ipsum dolor sit amet, consectetur 
 * adipisicing elit. Libero pariatur maxime 
 * praesentium. Similique qui, non aliquam 
 * nulla libero tenetur voluptatibus delectus, 
 * ex ab, aspernatur nam animi ipsa. Beatae 
 **/

/**
 * Lorem ipsum dolor sit amet, consectetur adipisicing elit. Veniam iste magni optio 
 * impedit rem labore minima cumque quaerat corrupti suscipit dicta, possimus commodi 
 * laudantium ipsam, tenetur. Omnis qui, veritatis eligendi dignissimos rem quos 
 * voluptatum quaerat neque at excepturi quod fugit veniam sapiente sunt blanditiis, 
 * autem illum alias delectus illo, nostrum, dolore aspernatur culpa. Omnis ea deserunt, 
 * vero odio praesentium repellendus enim recusandae at temporibus officia, obcaecati 
 **/

(我很抱歉,如果这是错误的stackexchange网站问这个,老实说我不知道​​该把它放在哪里)

0 个答案:

没有答案