Làm thế nào nói với javadoc rằng thời gian của tôi không kết thúc một câu

Question

javadoc sử dụng "câu" đầu tiên của nhận xét doc làm câu tóm tắt. Nó giả định rằng một khoảng thời gian theo sau là một dấu cách, tab, hoặc dòng terminator kết thúc câu. Giả sử tôi muốn viết tắt như "ví dụ" hoặc "v.v" trong tóm tắt của tôi; có cách nào để nói với javadoc không coi nó như là kết thúc của một câu? Tôi có thể thay thế giai đoạn với . nhưng tôi tự hỏi nếu có một cách ít xấu xí hơn.

Answer 1

Tốt nhất là tránh các dấu chấm câu trong câu đầu tiên. Trong How to Write Doc Comments for the Javadoc Tool nó gợi ý rằng bạn nên thay thế các nhân vật không gian như một cách giải quyết:

/** 
* This is a simulation of Prof. Knuth's MIX computer. 
*/ 

/** 
    * This is a simulation of Prof.<!-- --> Knuth's MIX computer. 
    */ 

Cá nhân, tôi sẽ chỉ bỏ qua các dấu chấm nếu tôi không thể tránh viết tắt hoàn toàn.