java - 编写开源 Java 的最佳实践

标签 java open-source

<分区>

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

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

编辑 - 我仍然缺少有关 zip 文件应包含哪些内容的直接、具体说明。对此有约定吗,还是我应该选择一些合理的结构?

最佳答案

我不确定是否会就“最佳实践”达成普遍一致,但您提到的项目可能有简单的答案:

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

我会想更多。

关于java - 编写开源 Java 的最佳实践,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1081960/

相关文章:

java - 检查一个字符串是否与另一个字符串相似

java - JSlider 未在空布局 JPanel 上绘制

c++ - 快速信息集或 .net 二进制压缩开源库

unit-testing - 一个单元在哪个级别测试无锁代码?

javascript - 有没有浏览器键盘绑定(bind)的开源库JS?

xml - 按属性对 XML 进行排序和修改

java - 为什么我收到错误 "the Method Is Undefined for the type"?

java - java 括号匹配算法

java - 如何加载从现有类继承的自定义类?

design-patterns - 内容交付网络算法、示例、代码