首页 ❯

编写开源 Java 的最佳实践 [已关闭]

java open-source
2022-09-03 13:27:26

在哪里可以找到一些编写开源 Java 代码的最佳实践？我不是在寻找如何正确编写代码的方向，而是在寻找分发，打包，文档以及除.java文件之外的所有其他方面。

我的目标是采用我编写的模块并将其发布为开源。

编辑 - 我仍然缺少有关zip文件应包含哪些内容的直接，具体说明。是否有这方面的惯例，或者我应该选择一些合理的结构？


答案 1

我不确定是否会在“最佳实践”上达成普遍共识，但你提到的项目可能很容易回答：

  1. 使用 java.net 或Sourceforge可以轻松分发。您将使用他们的标准发布代码，
  2. 打包将是 ZIP 文件。最好创建一个 MD5 哈希值，以便客户端能够检查其下载的完整性。
  3. 文档 - 是的，请很多。有单独的javadocs和一个参考指南，展示如何使用你的东西。
  4. 拥有一个允许匿名访问的公共SVN，以便人们可以自己获取和构建最新的代码。
  5. 有一个错误跟踪器，允许人们报告错误，新功能等。
  6. 设置用于讨论、反馈等的 Wiki。
  7. Maven已经成为一种开源标准。为那些想要查看和构建代码的冒险人士提供一个好的pom.xml。
  8. 单元测试和良好的代码覆盖率将有助于证明您对质量的承诺。

我会试着想得更多。


答案 2

参见卡尔·福格尔（Karl Fogel）的书《http://producingoss.com/- 可在线获取资源。


推荐
更多 »
标签
更多 »
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
推荐
更多 »