Skip to content

Commit ecf2cd3

Browse files
committed
lecture: add javadoc guide by oracle (Javadoc)
1 parent 79ae063 commit ecf2cd3

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

lecture/quality/javadoc.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ author: "Carsten Gips (HSBI)"
44
readings:
55
- "@Ullenboom2021 [Kap. 23.4]"
66
- "@googlestyleguide [Kap. 7]"
7+
- "@oraclejavadocguide"
78
tldr: |
89
Mit Javadoc kann aus speziell markierten Block-Kommentaren eine externe Dokumentation im HTML-Format
910
erzeugt werden. Die Block-Kommentare, auf die das im JDK enthaltene Programm `javadoc` reagiert,
@@ -202,6 +203,10 @@ Schauen Sie sich gern mal Klassen aus der Java-API an, beispielsweise eine `java
202203

203204
Unter [Documentation Best Practices](https://github.com/google/styleguide/blob/gh-pages/docguide/best_practices.md#documentation-is-the-story-of-your-code)
204205
finden Sie eine sehr gute Beschreibung, was das Ziel der Dokumentation sein sollte. Versuchen Sie, dieses zu erreichen!
206+
207+
Etwas technisch, aber ebenfalls sehr lesenswert ist der Style-Guide für Java-Software
208+
[How to Write Doc Comments for the Javadoc Tool](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html)
209+
von @oraclejavadocguide.
205210
:::
206211

207212

pm.bib

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -387,6 +387,15 @@ @Book{Ogihar2018
387387
langid = {en}
388388
}
389389

390+
@Online{oraclejavadocguide,
391+
author = {{Oracle}},
392+
title = {{How to Write Doc Comments for the Javadoc Tool}},
393+
url = {https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html},
394+
urldate = {2025-05-20},
395+
year = {2025},
396+
langid = {en}
397+
}
398+
390399
@Book{Osherove2014,
391400
author = {R. Osherove},
392401
title = {The Art of Unit Testing},

0 commit comments

Comments
 (0)