Nơi nên dự thảo tài liệu (yêu cầu, v.v.) được lưu trữ trong một dự án maven điển hình.Tài liệu dự án nên được lưu trữ trong dự án maven điển hình
Không có thư mục nào được liệt kê trong trang Introduction to the Standard Directory Layout là một ứng cử viên rõ ràng.
Rất tiếc, không có quy ước nào. Nếu bạn muốn tài liệu là một phần của trang web được tạo, rõ ràng là /src/site là một nơi tốt. Có lẽ bạn thậm chí có thể viết tài liệu ở định dạng APT?
Nhưng nhiều khả năng bạn có một bộ doc, pdf và xls file, đồ họa, e-mail, vv Bạn có thể đặt chúng dưới /src/site cũng đưa các siêu liên kết trong trang web hoặc ... xác định ước của riêng bạn , thật đáng buồn. Thông thường tôi đã thấy /src/main/doc(s), /src/doc(s) hoặc thậm chí /doc(s).
Bạn không muốn đặt tài liệu của mình ở /src/main/resources hoặc src/main/webapp, vì tệp sẽ là một phần của tạo phẩm được xây dựng (JAR/WAR) hiếm khi được mong muốn.
Is't src có phải là nguồn không? – Line
http://www.sonatype.com/books/mvnref-book/reference/site-generation-sect-dir-struct.html khuyến cáo cấu trúc sau
sample-project
+- src/
[..]
+- resources/
| +- images/
| | +- banner-left.png
| | +- banner-right.png
| |
| +- architecture.html
| +- jira-roadmap-export-2007-03-26.html
[..]
Tôi không biết tại sao Joao đã chỉnh sửa bài đăng này thay vì đăng một đề xuất thay thế. Anh ta đặt thư mục tài nguyên bên dưới thư mục trang web mà chắc chắn cũng là một tùy chọn hợp lệ. Đề xuất tôi đăng/trích dẫn sử dụng thư mục tài nguyên ở cấp cao nhất bên cạnh thư mục src và trang web (xem liên kết trong bài đăng). Người ta không nhất thiết muốn bao gồm tất cả tài liệu trong trang web. – RobE
Xin lỗi @RobE, sai lầm của tôi. –
Theo maven-javadoc-plugin:
Tham số
<javadocDirectory/>có thể được sử dụng để bao gồm các nguồn lực bổ sung, như HTML hoặc hình ảnh, trong javadoc tạo ra. Sau đó, bạn có thể liên kết đến các tài nguyên này trong các nhận xét javadoc của mình. Theo mặc định, tất cả các tài nguyên javadoc đều nằm trong thư mục${basedir}/src/main/javadoc. Lưu ý rằng bạn cần phải đặt tham sốdocfilessubdirsđể sao chép các thông số này.
Bạn có thấy sự khác biệt giữa tài liệu nói chung và JavaDoc không? :) – Line
Hơi. Nếu bạn xem JavaDoc như một trình tạo định dạng/tài liệu, vấn đề không bao giờ là viết tư liệu chỉ các API, nhưng viết các tài liệu xung quanh chúng để giải thích cách sử dụng chúng. Có được * trong * JavaDocs/Code và liên kết đến các API, luôn luôn có vẻ là một ý tưởng tốt. Nếu bạn đang ghi lại nội dung nào đó * khác * so với API, tôi sẽ nghĩ có thể sử dụng một số thứ khác (ví dụ: đánh dấu). – Alun
Tôi sẽ bỏ phiếu cho '/ docs'. Tất cả mọi thứ dưới '/ src' là maven thế giới, tốt hơn không để gây rối với điều đó. Tôi cũng nghĩ rằng bản thân dự án không tốt cho việc lưu tài liệu. Xem xét cài đặt wiki. –
Trong maven tất cả các tập tin nguồn đi theo/src. Các tài liệu mà bạn chỉnh sửa là các tệp nguồn, chúng nên đi theo/src ở đâu đó. Nếu bạn bắt đầu thêm các thư mục cấp cao mới, thì dự án của bạn không tuân theo quy ước maven và sẽ khó cho những người khác hiểu. –