Jak powiedzieć powiedzieć javadoc, że mój okres nie kończy zdanie

Question

javadoc używa pierwszego "zdanie" komentarza do dokumentu jako zdanie podsumowujące. Zakłada on, że kropka zakończona spacji, tabulatorem lub wierszem kończy zdanie. Załóżmy, że potrzebuję skrótu typu "np." lub "itp." w moim podsumowaniu; czy istnieje sposób, aby powiedzieć javadoc, aby nie traktować go jako końca zdania? Mogę zastąpić ten okres przez ., ale zastanawiam się, czy istnieje mniej brzydki sposób.

Answer 1

Najlepiej unikać okresów w pierwszym zdaniu. W How to Write Doc Comments for the Javadoc Tool to sugeruje, że należy zastąpić znak spacji jako obejście:

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

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

Osobiście chciałbym tylko pominąć kropkę gdybym nie mógł uniknąć skróty całkowicie.