文件名称:tutorialj:基于注释的实用程序,用于从 Java 代码创建教程
文件大小:12KB
文件格式:ZIP
更新时间:2024-07-03 08:30:31
Java
概括 tutorialj 是一个基于注释的实用程序,用于从 Java 代码创建教程。 目标 虽然 javadoc 提供了一种建立对 java 代码库的百科全书式访问的有效方法,但它不太适合将新用户引入代码库的任务。 tutorialj 的目标是帮助创建引导式代码之旅。 这是使用 java 注释实现的。 由于教程的来源是在 Java 中,因此它们的语法正确性更易于执行,并且在重构时更易于维护。 通过将 tutorialj 与 JUnit 注释相结合,还可以轻松检查使用示例是否也按预期运行。 我们不试图具有互操作性或取代 javadoc。 我们希望用这个工具注释的方法与用 javadoc 注释的方法是不相交的:javadoc 以公共 api 方法为目标,而我们以使用示例为目标,这些示例通常位于 src/test 和/或私有中。 安装 有两种安装方式: 集成到 gradle 脚本 只需添加以
【文件预览】:
tutorialj-master
----settings.gradle(31B)
----LICENSE.txt(626B)
----src()
--------test()
--------main()
----README.md(5KB)
----.gitignore(56B)
----build.gradle(1KB)