Javadoc'a dönemimin bir cümleye son vermediğini söyleyin joker,

Question

javadoc, bir doc yorumunun ilk "cümlesini" bir özet cümlesi olarak kullanır. Bir boşluk, sekme veya satır sonlandırıcı tarafından takip edilen bir sürenin cümleyi sonlandırdığını varsayar. "Ör." Gibi bir kısaltma istiyorum. veya "vb" özetimde; javadoc'a bir cümlenin sonu olarak davranmamasını söylemenin bir yolu var mı? Dönemi . ile değiştirebilirim ama daha az çirkin bir yol olup olmadığını merak ediyorum.

Answer 1

İlk cümle içindeki süreleri önlemek en iyisidir. How to Write Doc Comments for the Javadoc Tool yılında geçici bir çözüm olarak boşluk karakteri yerine önerdi oluyor: Ben tamamen kısaltmalar kaçamadı eğer

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

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

Şahsen, sadece nokta ihmal ediyorum.