Przepraszam za prawdopodobne pytanie typu FAQ, ale po prostu nie mogę znaleźć odpowiedzi.
O ile pamiętam Eclipse, pusty wiersz w komentarzu Javadoc jest wyświetlany (w wyskakujących okienkach Javadoc w źródle) jako podział wiersza (z dodatkowymi odstępami w pionie).
Jednak w Netbeans tak nie jest.
Czy mogę skonfigurować Javadoc, aby interpretował pusty wiersz jako podział wiersza?
Dodatkowe pytanie: czy mogę zastąpić domyślne zachowanie Netbeans (związane z tym) dla wyskakujących okienek Javadoc w źródle?
O czym mówię to:
Źródło
/**
* Paragraph One
*
* Paragraph Two
*/
void someMethod() { }
Interpretacja Eclipse
Paragraph One
Paragraph Two
Interpretacja Netbeans
Paragraph One Paragraph Two
Odpowiedzi:
Nie ma to nic wspólnego z Netbeans. Podejrzewam, że patrzysz na kod źródłowy w jednym przypadku, a dane wyjściowe Javadoc w drugim. Nowe linie nie mają znaczenia w HTML: ergo wyjście ich nie pokaże. Jeśli chcesz wprowadzić nową linię, użyj a
<p>
lub a<br>
.źródło
Nie jestem pewien, czy to pomoże w przypadku OP, jednak założyłem
<pre></pre>
dokument, aby netbean nie zepsuł mojego formatowania. Tak to będzie wyglądać/** * <pre> * Paragraph One * * Paragraph Two * </pre> */
Jest to najbliższe pokazaniu nowych wierszy w formacie tekstowym. Używam NetBeans 7.1.2. W ten sposób użycie
code format
opcji nie spowoduje przeformatowania dokumentu. Wyświetlanie dokumentu we wskazówkach jest nadal sformatowane.Aktualizacja: w Netbeans 8.x istnieje opcja w formatowaniu kodu, aby wyłączyć formatowanie komentarzy.
źródło
Istnieje już opcja
NetBeans
- przetestowana w wersji 8.2 - która pozwala zachować nowe linie w komentarzach i / lub dodać<p>
znacznik do swojego,Javadoc
jeśli to konieczneTools
menu, wybrałemOptions
Editor
karty, a następnie doFormatting
kartyLanguage
menu wybrałeśJava
, awCategory
menu wybrałeśComments
Preserve New Lines
wyboru wGeneral
sekcji, jeśli chcesz zachować nowe wiersze w komentarzach. Pozwoli to zachować nowe linie bez dodawania<p>
taguGenerate "<p>" on Blank Lines
pole wyboru wJavadoc
sekcji, jeśli chcesz również dodać<p>
tag .źródło
<p>
tam ręcznie, czasami można dodać dwukrotnie<p>``<p>
za pierwszym razem. Następnie działa zgodnie z oczekiwaniami.Zgadzam się z tobą, HTML nie należy do kodu źródłowego. Niestety, nie znalazłem wiele pomocy w szukaniu tego w Google. W rzeczywistości jest to dość łatwe do wdrożenia.
Oto niestandardowy Doclet, który możesz skompilować i używać:
import com.sun.javadoc.*; import com.sun.tools.doclets.standard.*; /** * Formats text-only comments with HTML. */ @SuppressWarnings("restriction") public final class TextDoclet { private static final Pattern NEWLINE_REGEX = Pattern.compile("\\n"); private static final String BR = "<br/>\n"; public static boolean start(RootDoc rootDoc) { for ( ClassDoc classdoc : rootDoc.classes()) classdoc.setRawCommentText(formatText(classdoc.getRawCommentText())); return Standard.start(rootDoc); } private static String formatText(String text) { return NEWLINE_REGEX.matcher(text).replaceAll(BR); } }
Przykład wywołania go za pomocą javadoc:
javadoc -docletpath ~/project/text-doclet/target/text-doclet-1.0.0-SNAPSHOT.jar -doclet com.myorg.textdoclet.TextDoclet -sourcepath ~/project/myapp/src/main/java -subpackages com.myorg.myapp
źródło
JavaDoc wyświetla sposób, w jaki style CSS zostały zdefiniowane. Aby to zrobić, możesz edytować style CSS powiązane ze znacznikami akapitu:
źródło
Jest to pseudo-rozwiązanie
(które niestety wpływa tylko na wygenerowany javadoc, ale nie wpływa na wyświetlanie javadoc w źródle Netbeans).
Określ arkusz stylów zawierający następujące elementy:
źródło
Nie mam pojęcia, co robi tutaj Eclipse, ale jeśli chcesz ogólnie tego zachowania (nie tylko IDE), być może będziesz musiał utworzyć nowy Doclet (który może być oparty na domyślnej dokumentacji HTML), zamiast tego wstawić
<p>
at każda pusta linia lub coś takiego.źródło