陕西
为什么我应该注释我的代码？
如果您实际上是使用 Java、JavaScript、Python、PHP 编写代码。您可能听说过技术文档和以下内容：
- JavaDoc
- JSDoc
- 文档字符串
- PHP文档
如果你还没有听说过“如何评论你的代码”。所以你是，你是，或者你将面临这个问题：
“这段代码做什么？？？ ”
而且您知道当某些事情不起作用并且您无法理解为什么时会很痛苦！
动图
当您使用外部程序时，您的反应是阅读有关该程序的文档以了解如何使用它。
当您注释代码时，目标是相同的。您将来会为您或使用或改进此代码的人编写一些详细信息。
目标
目标是多重的，在这段代码中想想你在 2 年内。你会很高兴看到一些评论解释了你之前添加的这些奇怪的类是什么。
现在，如果您不单独编码。想想你的同事会阅读和使用你的代码。
如果你正在制作一个开源程序，请考虑所有在未来使用你的代码的人。
我想你现在明白了，当你评论你的代码时，你实际上：
- 您为自己和其他人节省了时间
- 描述并拥有可读的代码
- 您的代码将可以访问
我什么时候应该发表注释？
建议对您的类进行评论，您的功能并在必要时使用内联文档。我认为这是对可读代码的最低要求。
一个代码有注释，是一个可读的代码。但是，请使用节俭的评论。
当然，如果你的函数被命名sum为例如，并接受两个参数。知道函数的作用真的很简单。
个人认为，当函数超过 10 行时，您应该对函数进行注释，并且它是类所必需的。
请记住，开发人员不仅仅是编码。
开发人员维护、调试、关注演变、记录并思考如何解决问题。
所以请评论你的代码，让明天的“你”和所有阅读你的代码的人快乐。你将迈出成为编程之神的一步。
动图
如果您有任何建议或评论，当然还有这篇文章是否有趣，请告诉我。
关于这个有很多话要说，随意表达你的观点，所以不要犹豫。
特别声明：以上内容(如有图片或视频亦包括在内)为自媒体平台“网易号”用户上传并发布，本平台仅提供信息存储服务。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.
