首页 ❯

在 GitHub 上显示 JavaDocs

github java markdown javadoc
2022-09-01 00:30:13

我正在寻找一种方法将javadocs从我的开源项目（在Eclipse中生成）转换为GitHub MarkDown，或者想出一些其他简单的解决方案来在GitHub上显示我的文档（羞于简单地添加目录）。有没有一个简单的解决方案？我可以简单地将 GitHub 指向我的目录吗？还有比这更优雅的东西吗？我一直在谷歌上罢工。docsREADME.mddocs


答案 1

我不认为用MarkDown制作一个可用的Javadoc是不可能的。最好的解决方案可能是提交您在分支上（或在目录中，具体取决于项目的设置）上生成的Javadoc。它将在以下位置提供：gh-pagesdocs/

http://username.github.io/projectname

以下是我的一个项目的一个例子：

http://ebourg.github.io/jsign/apidocs/


答案 2

目前，您还可以使用Github Pages托管Javadoc，不仅可以从分支中托管，还可以直接从分支中的文件夹中托管Javadoc。您可以在此处查看有关此主题的帮助部分（另请查看下面的附加图像）。gh-pages/docsmaster

enter image description here

此外，Github上有一个项目，旨在将Javadoc转换为Markdown（尚未尝试过，只是留下了参考）。


推荐
更多 »
标签
更多 »
php pass-by-reference optional-parameters default-value javascript arrays dom function string object serialization tostring visibility syntax jslint use-strict operators equality equality-operator identity-operator datetime timestamp date-arithmetic redirect angularjs loops foreach iteration scope variables
推荐
更多 »