在代码中添加注释安全吗?

问题描述 投票:0回答:5

我相信代码告诉你如何做,但注释告诉你为什么。当您决定创建应用程序的另一个版本时,评论非常有帮助。但我真的应该在代码中添加注释吗? 我听说一些黑客可以解码我的应用程序。 评论可能会帮助他们理解它! 我的问题很简单,当我的构建类型为“发布”时,是否有任何工具可以从我的项目中删除注释?或者如果 minifyEnabled true 已经这样做了?

android security comments
5个回答
2
投票

是的,它是安全的,这对于任何其他开发人员在您的代码上工作都会有帮助,但如果您正确组织和命名事物,他也可以在没有注释的情况下理解它。如果有人可以破解你的代码,他不需要你的注释来理解它,所以不要介意这一点,并确保编写干净的代码。


2
投票

在这个行业工作了一段时间后,我可以告诉你评论是工作中最有用的方面。没有什么比打开一个包含 15 年旧代码的文件,并且不得不浪费 2 个小时在没有指南的情况下费力地浏览代码更好的了。为您的代码写注释!如果你几个注释都不能把代码解释清楚,说明你自己没看懂!

编辑:如果有人黑进你的代码,他们不需要你的评论来理解它,我会将你的安全问题集中在其他领域,查看 OWASP 的前 10 个列表... https://www.owasp .org/index.php/Top_10-2017_Top_10


2
投票

我建议阅读鲍勃叔叔的清洁代码https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882

它有一整章专门讨论评论(第 4 章,如果我没记错的话)。

关于混淆代码,Proguard 可以完成这项工作。

关于 proguardminifyEnabled 之间的区别更详细的解释在这里: Android Gradle 插件中的“minifyEnabled”和“useProguard”有什么区别?


1
投票

*如果有任何工具可以从我的项目中删除注释*,Android 编译器实际上会忽略 Java 文件中的所有注释。

当你的Java文件被编译成Java类时,它们被编译时没有注释,你可以说编译器会忽略它们。

所以不用担心代码中的注释。


0
投票

向代码添加注释通常被认为是一种很好的做法,原因如下:

文档:注释有助于记录代码,解释其目的、功能和任何重要的注意事项。这使得其他开发人员(或未来的你)更容易理解和维护代码 清晰度:注释可以澄清代码的复杂部分或提供为什么做出某些决定的背景。这提高了可读性并减少了误解的可能性。 调试:注释还可以通过提供对代码不同部分的逻辑或预期行为的见解来帮助调试。 协作:在团队环境中,注释通过允许团队成员有效地沟通代码库来促进协作。

© www.soinside.com 2019 - 2024. All rights reserved.