向行业公司的遗留应用程序/代码中的代码添加注释?

问题描述

我是美国一家公司的初级软件工程师。正如你们工程师所知,很多时候我都会遇到大量未记录的代码,几乎没有/零评论(我主要用 Java 编写代码)。

现在,我知道你可能会说“好吧,评论代码然后伙计!”的逻辑响应,我以前做过,但我注意到整个代码库都没有注释,所以看起来很“奇怪”有一些评论的方法等等。这可能需要更多的时间,或者有时我只是缺乏有关应用程序或系统如何运行的“大”规模的信息,所以我无法发表评论整个代码库或功能。

我想问一下那些也有未注释/未记录的遗留应用程序并在行业工作的软件工程师:

  1. 当我处理缺陷/错误和新功能时,我应该修复并评论整个代码库
  2. 不要管它,因为它是一个遗留应用程序,并遵循之前设置的模式(无评论)
  3. 随着时间的推移,在我处理应用程序时评论各个部分
  4. // this is a comment 这样的简单注释是首选还是 java-doc 样式的注释? (下):
     /**
     * 
     * @param the four byte rgb pixel value from image
     * @return the bitwise AND of the rgb value and a bitmask
     */

谢谢!

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)