Tag

Code Documentation

1 views collected around this technical thread.

DaTaobao Tech
DaTaobao Tech
Feb 7, 2025 · R&D Management

Non-Functional Quality Delivery and Code Documentation Practices

The article highlights how vague requirements, weak architecture, and inconsistent team habits undermine non‑functional quality, then offers Java‑focused guidance on using concise comments, proper Javadoc, self‑documenting code, clear exception versus business‑error handling, and balancing standard interfaces with targeted specialization to improve maintainability and performance.

Code DocumentationException HandlingJava
0 likes · 19 min read
Non-Functional Quality Delivery and Code Documentation Practices
IT Xianyu
IT Xianyu
Dec 28, 2021 · Fundamentals

How to Configure Class and Method Comment Templates in IntelliJ IDEA

This guide explains step‑by‑step how to set up class and method comment templates in IntelliJ IDEA, including creating file and live templates, configuring parameters, adding Groovy scripts for @param and @return generation, and verifying the generated Javadoc comments for Java files.

Code DocumentationIDE configurationIntelliJ IDEA
0 likes · 6 min read
How to Configure Class and Method Comment Templates in IntelliJ IDEA