javadoc使用doc注释的第一个“句子”作为摘要句子。假定句号后跟一个空格,制表符或行终止符,以结束该句子。假设我想要一个缩写,例如“e.g.”或“等”。在我的总结中;有没有办法告诉javadoc不要将其视为句子的结尾?我可以用.
代替句点,但是我想知道是否有一个不太丑陋的方法。
最佳答案
最好避免在第一句中使用句号。建议在How to Write Doc Comments for the Javadoc Tool中替换空格字符作为一种解决方法:
/** * This is a simulation of Prof. Knuth's MIX computer. */ /** * This is a simulation of Prof.<!-- --> Knuth's MIX computer. */
就个人而言,如果我不能完全避免缩写,我只会忽略点。
关于javadoc - 如何告诉javadoc我的句号没有结束,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/18282086/