Tagged articles
javadoc
20 articles · Page 1 of 1
AI code assistants often misinterpret Java library placeholders because they rely on web searches or bytecode decompilation, which miss Javadoc details; the Javadocs MCP server indexes Maven Central Javadocs, letting AI retrieve accurate method signatures and placeholder rules, and can be added to Claude Code with a simple configuration.
AIClaudeHutool
0 likes · 7 min read

The article explains why high‑quality Javadoc is essential for enterprise‑level Java backend projects, walks through the most common Javadoc tags and HTML elements, provides concrete code examples—including @param, @return, @throws, @see, @deprecated—and shows how thorough comments improve readability, maintainability, and serve as a catalyst for refactoring.
Best PracticesJavabackend development
0 likes · 14 min read

This article explains how an IntelliJ plugin uses large‑language‑model AI to read your Java method body and automatically produce accurate Javadoc comments, eliminating the need for manual documentation and overcoming the limitations of simple name‑translation tools.
AIIntelliJJava
0 likes · 6 min read

This article explains Java’s three comment types, highlights a surprising case where a line starting with // still runs due to a Unicode escape sequence, and shows how the compiler processes \u000d to execute the code.
Backendcommentsjavadoc
0 likes · 3 min read

This guide explains step‑by‑step how to configure IntelliJ IDEA’s Live Templates to automatically generate Javadoc comments for Java methods, including creating a custom template group, defining variables, setting scope, and showcasing useful Java‑8 snippets, while also noting promotional offers for activation tools.
IDE TipsIntelliJ IDEAJava
0 likes · 6 min read

This article presents a comprehensive approach to building an Android code impact analysis tool that leverages Git diff to locate modified lines, employs ASM-based class and method visitors to construct upward and downward call chains, extracts Javadoc and custom tags, and visualizes the results for developers and testers.
ASMAndroidGit
0 likes · 21 min read

This article explains the purpose and syntax of Java annotations, describes built‑in annotations such as @Override, @Deprecated and @SuppressWarnings, shows how to create and use custom annotations with meta‑annotations, and demonstrates a lightweight testing framework that records annotation‑driven test failures.
AnnotationsCustom Annotationsjavadoc
0 likes · 11 min read

Java 18 adds the @snippet tag to JavaDoc, offering syntax‑highlighted, validated code examples, superior IDE support, and error checking compared to the older @code tag, making documentation clearer and more interactive for developers.
@snippetIDEJava
0 likes · 3 min read

This guide walks you through configuring IntelliJ IDEA's File and Code Templates and Live Templates to automatically generate class and method Javadoc comments, including author, date, @param, and @return tags, with step‑by‑step screenshots, Groovy scripts, and a Q&A section.
IDEIntelliJ IDEAJava
0 likes · 8 min read

This guide shows how to configure IntelliJ IDEA to automatically generate class and method Javadoc comments using File and Code Templates and Live Templates, including custom Groovy scripts for @param and @return tags, applicable contexts, and common pitfalls.
Live Templatesautomationintellij-idea
0 likes · 7 min read

This guide explains how to set up IntelliJ IDEA class and method Javadoc templates using File and Code Templates and Live Templates, including the required abbreviation, description, template text, applicable contexts, and custom Groovy scripts for automatically generating @param and @return annotations.
Groovy ScriptIntelliJ IDEAJava
0 likes · 6 min read

This guide shows how to configure IntelliJ IDEA to automatically insert class and method Javadoc comments using file and code templates and live templates, including custom Groovy scripts for @author, @date, @param, and @return annotations.
GroovyIntelliJ IDEAJava
0 likes · 9 min read

This guide shows how to configure IntelliJ IDEA to automatically generate class and method Javadoc comments using file templates and live templates, including custom Groovy scripts for @param and @return annotations, applicable contexts, and step‑by‑step screenshots.
IDE automationIntelliJ IDEAJava
0 likes · 8 min read

This guide explains how to set up IntelliJ IDEA templates to automatically generate class and method Javadoc comments, including adding author and date placeholders, creating live templates for @param and @return annotations, and customizing variable expressions with Groovy scripts.
IntelliJ IDEAJavaautomation
0 likes · 6 min read

This guide shows how to configure IntelliJ IDEA to automatically generate Javadoc class and method comments using file templates and live templates, including step‑by‑step settings, custom Groovy scripts for @param and @return, and verification of the results.
IntelliJ IDEAJavaLive Templates
0 likes · 7 min read

This guide shows how to configure IntelliJ IDEA to automatically insert Javadoc class and method comments, including author, date, @param and @return tags, using File and Code Templates and Live Templates with custom Groovy scripts.
Groovy ScriptIntelliJ IDEAJava
0 likes · 8 min read

This guide shows how to configure IntelliJ IDEA to automatically insert class‑level Javadoc comments and smart method‑level @param and @return annotations using custom live templates, covering template creation, variable expressions, and verification steps.
IDE automationIntelliJ IDEAJava
0 likes · 8 min read

This guide walks you through configuring IntelliJ IDEA to automatically insert class‑level and method‑level Javadoc comments using File and Code Templates and Live Templates, including GroovyScript expressions for dynamic @author, @date, @param, and @return tags.
GroovyScriptIDE configurationIntelliJ IDEA
0 likes · 8 min read

This article presents comprehensive Java coding standards—including naming conventions, Javadoc documentation, and the use of CheckStyle for automated style checking—along with a list of practical development habits to improve code quality, maintainability, and productivity.
Best PracticesCheckStyleJava
0 likes · 9 min read


21CTOMay 2, 2019 · Fundamentals
This document defines the complete Google Java Style Guide, detailing file naming, structure, formatting, naming conventions, and best‑practice recommendations—including whitespace, braces, imports, annotations, Javadoc, and exception handling—to ensure Java source files conform to Google’s coding standards.
Best PracticesFormattingJava
0 likes · 35 min read
