Właśnie zacząłem używać IntelliJ IDEA do programowania w Javie i widzę tagi (czy są one nazywane tagami?), Takie jak @param i @return. Jakie jest znaczenie tych tagów? IntelliJ faktycznie narzeka, jeśli nie mam tych tagów w moim kodzie!Co to są znaczniki takie jak @param i @return w IntelliJ IDEA?
Jakie są najważniejsze informacje i do czego są używane?
Nie mogłem znaleźć niczego istotnego w dokumentacji IntelliJ odnośnie do tych tagów.
Tak, są to tak zwane tagi. Jeśli widzisz te znaczniki w komentarzach, to dokumentują one parametry twojej metody i zwracają wartość.
Mogą być automatycznie przetwarzane w celu wygenerowania dokumentacji JavaDoc. Wygenerowana dokumentacja będzie podobna do wersji Java API Documentation. Zobacz how to write doc comments for the JavaDoc tool.
Dzięki. Stosując małpę-zobacz małpa-do, przyjmuję, że ogólny format znacznika to @tag
Brak karty, tylko spacja. Ponadto, aby było to wyraźne, te znaczniki nie są specyficzne dla IntelliJ. –
Czy te znaczniki są bezużyteczne w kodzie utworzonym poza IDE? To znaczy, kod utworzony za pomocą edytora tekstu i skompilowany w linii poleceń? – InvalidBrainException
w kodzie lub w komentarzach? – stivlo
W komentarzach w kodzie, heh. – InvalidBrainException
Wymagane tagi i poziom ostrzeżenia to konfigurowalna inspekcja - wystarczy wyszukać "javadoc" w ustawieniach. –