Tôi đang làm việc trên một thư viện nhỏ cung cấp việc triển khai các số liệu chuỗi cơ bản, nổi tiếng. Chủ yếu là cho giáo dục của riêng tôi. Vì vậy, sự phát triển xảy ra bất cứ khi nào tôi có một chút thời gian rảnh rỗi.
Do đó, tôi đã tự động hóa hầu hết các quy trình để tôi có thể phát hành phiên bản thường xuyên khi tôi làm việc với nó mà không cần quá nhiều nỗ lực. Tuy nhiên, việc duy trì tài liệu Java vẫn là một gánh nặng vì nó bao gồm các ví dụ.
Khi API phát triển, tôi phải kiểm tra lại từng ví dụ một cách thủ công. Có cách nào tốt hơn để làm điều này?
Tôi đã cân nhắc việc chuyển tài liệu và ví dụ vào một dự án riêng (ví dụ Caliper Tutorial ) để nó có thể được tái hiện và biên dịch cùng với mã thông thường. Tuy nhiên, điều đó không di chuyển tài liệu ra khỏi lớp học.
Vì vậy, vâng. Tôi muốn có bánh của tôi và ăn nó quá. : D
* <h2>Tokenization</h2>
*
* Tokenization cuts up a string into tokens e.g.
* <code>chilperic ii son of childeric ii</code> is tokenized into
* <code>[chilperic, ii, son, of,
* childeric, ii]</code>. Tokenization can also be done repeatedly by tokenizing
* the individual tokens e.g.
* <code>[ch,hi,il,il,lp,pe,er,ri,ic, ii, so,on, of, ch,hi,il,ld,de,er,ri,ic, ii]</code>
* <p>
*
* <pre>
* <code>
* {@code
* return new StringMetricBuilder()
* .with(new SimonWhite<String>())
* .tokenize(new Whitespace())
* .tokenize(new QGram(2))
* .build();
* }
* </code>
* </pre>
*
* <p>
Nếu ở trên nó quá trừu tượng. Đây là một mẫu tài liệu. Hiện tại tôi đang thêm các hàm tạo tĩnh theo lời khuyên của Java hiệu quả, ví dụ như Tokenizers.createQGram(2)trong khi khấu hao phương thức hàm tạo. Mỗi lần tôi làm điều gì đó như thế này, tôi phải cập nhật mã ví dụ ở trên và kiểm tra xem nó có còn hoạt động không.