手册的内容是 Javadoc,您可以在 Eclipse 和 java 以及 android 中使用它。
这里有一些链接,首先:
http ://en.wikipedia.org/wiki/Javadoc
然后我可以快速解释为什么 javadoc 对你有用,首先它允许使用(在我看来)你能想象的最简单的方式创建一个真正的手册(java API 是用 javadoc 创建的)。您必须使用一个特殊的注释标签,即:
/**
*
**/
当您将它放在任何声明(方法、类、接口、字段等)之前时,它将包含在 javadoc 中。您可以添加标准的东西,例如,您可以指定方法的描述、它需要@return
什么@params
以及许多其他东西,非常小心和精确,您可以将 javadoc 相互链接,并创建非常复杂和精确的文档。
在 eclipse 中 javadoc 很有用,因为 eclipse 本身默认允许用户与 javadoc 交互。例如,如果您想知道一个方法的作用,只需将鼠标悬停在该方法的名称上,就会出现一个黄色的小对话框。如果您还使用 ctrl-space,您也可以在其中获得一些提示。例如,按 ctrl-space 会显示所有可用的公共方法,每个方法的 javadoc 都有黄色的描述对话框。如果您正在实例化一个新对象,您可以看到确定了多少(以及它们具有哪些参数)构造函数等等,我认为它非常有用和重要。
对于第二件事,如果我了解您想要的东西,可能像 JUnit(用于测试的单元)之类的东西对您来说可以。
http://www.junit.org
JUnit 是一个用于测试代码的单元,可以与 eclipse 完全集成。简而言之,对于代码的每一部分,您应该编写一个或多个测试来检查其行为是否正确。一旦您编写了一些测试,您可以使用用户友好的界面自动运行它们,告诉您有多少测试失败,有多少通过以及存在什么样的错误。
为什么测试我的代码中的每一个小(愚蠢的?)东西都很有用?
想象一下,您有一个工作代码(您的代码)。想象一下,你有人在做这件事(你的学生)。
用户如何确定他/她所做的任何更改都可以使用现有代码?
他/她应该运行程序并一一检查每个功能以发现错误。
你明白这是不可能的。所以 JUnit 只需单击一下(如果您还想在后台)就可以为您完成。
因此学生可以添加代码并运行测试以查看预先存在的代码是否仍在工作。
如果一切正常,学生也可以编写自己的测试来自动测试。事实上,JUnit 允许您测试代码的每一部分而不依赖于其他部分,通过这种方式,您还可以在不连接到网络的情况下测试 Internet 连接,只是“模拟”连接。
我让这部分没有解释,因为它是一个漫长而复杂的部分。我给你这个“输入”是为了刺激你阅读有关测试和 XP 编程的知识。
啊,欢迎来到stackoverflow!如果你喜欢这个答案并且认为这个答案对你的问题是正确的,你可以用左边的小检查来检查它。