有很多优秀的例子和指南(参见参考文献 [1])为 Java 代码编写好的 javadoc
我们正在使用 Restlet 通过 WADL 记录我们的 REST 接口
http://wiki.restlet.org/docs_2.0/13-restlet/28-restlet/72-restlet.html
引用该教程,我们正在添加类似...的代码
@Override
protected void describeDelete(MethodInfo info) {
info.setDocumentation("Delete the current item.");
RepresentationInfo repInfo = new RepresentationInfo();
repInfo.setDocumentation("No representation is returned.");
repInfo.getStatuses().add(Status.SUCCESS_NO_CONTENT);
info.getResponse().getRepresentations().add(repInfo);
}
是否有编码标准或简洁的 WADL 示例。例如,我们不想复制隐含在 HTTP 动词或 URL 中的信息。
参考 1. 如何为 Javadoc 工具编写文档注释。我是新用户,无法添加 URL,但我指的是
www.oracle.com/technetwork/java/javase/documentation/index-137868.html上的指南