API documentation from source code comments: a case study of Javadoc
Open accessThe DOI matches its Crossref record.
Abstract
This paper describes in a general way the process we went through to determine the goals, principles, audience, content and style for writing comments in source code for the Java platform at the Java Software division of Sun Microsystems. This includes how the documentation comments evolved to become the home of the Java platform API specification, and the guidelines we developed to make it practical for this document to reside in the same files as the source code.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cited by
Improved Code Summarization via a Graph Neural Network
LeClair, A., Haque, S., Wu, L., & McMillan, C. (2020) · Proceedings of the 28th International Conference on Program Comprehension · doi:10.1145/3387904.3389268 · Cited by 312
A Neural Model for Generating Natural Language Summaries of Program Subroutines
LeClair, A., Jiang, S., & McMillan, C. (2019) · 2019 IEEE/ACM 41st International Conference on Software Engineering (ICSE) · doi:10.1109/icse.2019.00087 · Cited by 294
SPOON: A library for implementing analyses and transformations of Java source code
Pawlak, R., Monperrus, M., Petitprez, N., Noguera, C., & Seinturier, L. (2016) · Software: Practice and Experience · doi:10.1002/spe.2346 · Cited by 261
Improving automated source code summarization via an eye-tracking study of programmers
Rodeghero, P., McMillan, C., McBurney, P. W., Bosch, N., & D'Mello, S. (2014) · Proceedings of the 36th International Conference on Software Engineering · doi:10.1145/2568225.2568247 · Cited by 198
“Categories and Subject Descriptors D.2 [Software]: Software Engineering; D.2.9 [Software Engineering]: Management—Productivity General Terms Algorithms, Documentation Keywords Source code summaries, program comprehension”
BackgroundInfluentialRetrieve and refine: exemplar-based neural comment generation
Wei, B., Li, Y., Li, G., Xia, X., & Jin, Z. (2020) · Proceedings of the 35th IEEE/ACM International Conference on Automated Software Engineering · doi:10.1145/3324884.3416578 · Cited by 69
“Assuming the first sentence of the Javadoc summarizes the method’s behavior [24], the authors extracted the first sentence or line from the Javadoc as a comment of the method and filtered out non-English samples.”
Method
Metadata
- Authors
- Kramer, D.
- Venue
- Proceedings of the 17th annual international conference on Computer documentation
- Publisher
- ACM
- Published
- 1999-10
- Pages
- 147-153
- OpenAlex
- W1994683471
- Cited by
- 142
- References
- 0
- FWCI
- 2.08
- Type
- conference paper
- Language
- en
- Open access
- bronze
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
How to cite
Cite CoChat for the checks on this page, and the paper for its own findings.
- This page
- CoChat. (2026). Citation check: API documentation from source code comments: a case study of Javadoc. https://app.cochat.ai/papers/10.1145/318372.318577
- The paper
- Kramer, D. (1999). API documentation from source code comments: a case study of Javadoc. Proceedings of the 17th annual international conference on Computer documentation. https://doi.org/10.1145/318372.318577
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.