|
它的步骤很有趣。专业精神。虽然中的注释不是由虚拟机编译的也不属于公共领域但建议在注释中保留一些专业的框架。你永远不知道谁会读到那封对你办公室闺蜜的含蓄侮辱并祈祷那不是顾客。注释代码时要避免的常见错误在中包含注释时最常见的错误是什么从不包含任何评论到超出扩展范围再到缺乏连贯性。请记下编写代码时应采取。
的预防措施。忘记评论了。将您头脑中出现的代码视为理所当 英国电话号码清单 然可能是一个错误并且会减慢工作流程因为如果第三方获取它们很容易提出问题。过度扩展。留下很长的注释也会阻碍开发人员之间的工作流程因为它使得很难找到关键概念。消息不一致。为了使代码更容易阅读建议您遵循统一的标准。评论代码已禁用。评论一个被禁用的代码。
是浪费时间你应该在离开之前检查一下情况是否如此。泄露机密信息。在任何公共媒体上泄露机密信息都是一个非常糟糕的主意其中包括代码行。你永远不知道谁能找到它们。让您的评论保持最新的提示随着项目的增长代码注释很容易变得过时。这就是为什么我们将为您提供三个提示以保持更新并防止这种情况发生。查看。当然您已经找。
到了不再适用于代码行的注释请定期使用。利用等自动技术文档生成工具使信息不会过时。交流。当您进行更改时请通知项目中的其他利益相关者以便他们考虑并检查自己的注释以免出现过时的信息。接受培训并创建您的代码编程是开发人员最需要的技能之一您可以通过此远程课程进行该主题的培训填。
| 
发新帖
