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.Jak powiedzieć powiedzieć javadoc, że mój okres nie kończy zdanie
8
A
Odpowiedz
4
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.
Powiązane problemy
- 1. Jak mogę powiedzieć, że mój kod działa w trybie Mono?
- 2. Jak powiedzieć Google, że strona została przeniesiona?
- 3. Jak mogę powiedzieć, że `ConcurrentDictionary.GetOrAdd` nie dodaje wartości?
- 4. Jak powiedzieć JAXB, że kolejność elementów nie ma znaczenia?
- 5. Jak formalnie powiedzieć, że funkcja nie jest ścisła w argumentacji?
- 6. Jak powiedzieć .hover() czekać?
- 7. Co może WinDbg mi powiedzieć, że Visual Studio nie może?
- 8. Jak mogę powiedzieć visualvm, gdzie znaleźć mój kod źródłowy?
- 9. Jak mogę powiedzieć kompilatorowi, że moja klasa rozwiązuje metody dynamicznie?
- 10. Jak mam powiedzieć cmake, że mój projekt ma połączyć statycznie biblioteki?
- 11. Jak mogę powiedzieć, że narzędzie testowe Perla ignoruje pewne testy?
- 12. Jak powiedzieć eslint że wolisz apostrofów wokół struny
- 13. Historia Api: Jak powiedzieć przeglądarce, że strona ładuje się?
- 14. W jaki sposób mój program może powiedzieć, czy działa Delphi?
- 15. Jak powiedzieć RadioButtonList, aby NIE generować tabeli
- 16. Jak powiedzieć bash, aby nie rozszerzać zmiennej $ _?
- 17. Jak powiedzieć Nie jest pusty w VBA
- 18. Jak mogę powiedzieć Emacsowi, że zmieniła się moja gałąź git?
- 19. W jaki sposób powiedzieć PHPStorm debugger, że mój projekt ma root dokumentu inny niż root projektu
- 20. Czy można powiedzieć kompilatorowi, że metoda zawsze generuje wyjątek
- 21. Czy mogę powiedzieć, że ggpairs używa skali logowania?
- 22. Czy istnieje sposób, aby powiedzieć NLTK, że pewne słowo nie jest właściwym rzeczownikiem, ale rzeczownikiem?
- 23. Jak mogę powiedzieć, którego vim użyć?
- 24. Django get_or_create, jak powiedzieć popełnić = False
- 25. Jak powiedzieć Proguardowi, by zaciemnił nazwy klas?
- 26. Jak mogę powiedzieć angularjs do „odświeżenia”
- 27. Jak można powiedzieć, png8 z png24
- 28. Jak powiedzieć ogórek przejść do strony?
- 29. Jak powiedzieć valgrind, aby zapamiętywać rozwidlone procesy?
- 30. Jak powiedzieć „should_receive” więcej razy w RSpec
Dzięki, to zdecydowanie lepsze niż hack, który wymyśliłem. Jestem dość szczególny, jeśli chodzi o pisanie rzeczy, dlatego pominięcie kropki nie jest dla mnie odpowiednią opcją. – ajb
@ajb Nie przetestowałem tego, ale może również można [wpisać nie łamiącą się przestrzeń] (https://en.wikipedia.org/wiki/Non-breaking_space#Keyboard_entry_methods) bezpośrednio, bez korzystania z encji html. – Kapep