在我的软件开发经历中,我曾经遇到过编写代码时犯的一些错误,而这些错误在《代码大全2》这本书中都有提到。
其中一个问题是过度地注释代码。我过去常常使用很多注释,认为它们可以帮助我自己和其他人更好地理解代码。
但是,在阅读这本书之后,我了解到这种做法可能会带来一些负面影响,并会让代码更难以阅读。
首先,注释有时候会过时,这意味着即使有注释,开发人员也可能难以理解代码的意图或修改过程。
而且,重复的注释会增加代码的复杂性,并在维护代码时造成不必要的负担。最重要的是,注释可能会误导读者,
让他们产生错误的理解或期待。为了解决这个问题,书中提供了一些解决方案。
首先是通过重构代码来提高代码的自我说明性,这样可以减少注释的需要。
其次是使用自然语言生成工具,如Doxygen和Javadoc等等,自动生成可读性强的注释和文档。
这些工具不仅可以减少手动编写注释的工作量,而且可以提供丰富的文档和关键词,帮助开发人员理解代码的意图和功能。
另一个问题是全局变量的滥用。在我的开发项目中,我曾经使用过很多全局变量,认为它们可以方便地共享数据。
然而,在阅读此书时,我发现全局变量的使用不仅会让代码更难读懂,还会增加代码的副作用并带来不必要的风险。
全局变量会对代码的可维护性和可读性造成负面影响。它们可能被意外地修改或用于不正确的操作,
并且全局变量很难被封装或设计成独立的组件。为了解决这个问题,书中提出了一些建议。
首先是尽可能避免全局变量的使用,并使用本地局部变量或者函数参数进行数据传递。
其次是封装全局变量的访问权限,并将它们作为对象或者组件的一部分来处理。
总的来说,阅读《代码大全2》让我意识到代码质量对软件开发的重要性,并帮助我培养了更好的编程习惯。
这本书提供了很多代码质量的最佳实践,并与那些犯过相同错误的软件开发人员分享他们的经验和教训。
标签:01,开发人员,代码,笔记,注释,阅读,全局变量,大全 From: https://www.cnblogs.com/sgle0722/p/17362981.html