我的经验法则是,任何需要那么多信息的代码或许应该分解成更小的方法。而且注释中这样的信息应该挪到实际的代码之外。而在上面的例子中,像流水账一样记录的业务规则和业务流程——却有可能随着时间而改变。
结论关于如何正确地写好代码注释,简单地搜一下的话,网上有很多很多。有些甚至可能会告诉你如何尽可能地不在代码中提供注释。
相反,我想分享一些我有幸作为一个应用程序开发人员所读过的一些滑稽的注释。请记住,我在应用程序开发上有着20年以上的编译经验——反映了例外,而不是规则。
我的经验法则是,任何需要那么多信息的代码或许应该分解成更小的方法。而且注释中这样的信息应该挪到实际的代码之外。而在上面的例子中,像流水账一样记录的业务规则和业务流程——却有可能随着时间而改变。
结论关于如何正确地写好代码注释,简单地搜一下的话,网上有很多很多。有些甚至可能会告诉你如何尽可能地不在代码中提供注释。
相反,我想分享一些我有幸作为一个应用程序开发人员所读过的一些滑稽的注释。请记住,我在应用程序开发上有着20年以上的编译经验——反映了例外,而不是规则。
内容版权声明:除非注明,否则皆为本站原创文章。
转载注明出处:https://www.heiqu.com/80596e2490a0132e622e5db0a58d3376.html