Tagged articles

code documentation

7 articles · Page 1 of 1
DeepHub IMBA
DeepHub IMBA
May 29, 2026 · Fundamentals

lat.md: Transform Any Project Code into a Queryable Knowledge Graph

lat.md builds a persistent, verified knowledge graph from code, documentation, and media by splitting documents into linked fragments, automatically scanning and validating them, and enforcing a "summary first" rule to keep AI‑driven project maps accurate and up‑to‑date.

AI integrationautomated verificationcode documentation
0 likes · 7 min read
lat.md: Transform Any Project Code into a Queryable Knowledge Graph
Shepherd Advanced Notes
Shepherd Advanced Notes
Feb 4, 2026 · Backend Development

Mastering Java Code Comments: The Ultimate Guide to High‑Quality, Readable, Architecture‑Level Documentation

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.

Backend DevelopmentBest PracticesJava
0 likes · 14 min read
Mastering Java Code Comments: The Ultimate Guide to High‑Quality, Readable, Architecture‑Level Documentation
JD Tech
JD Tech
Jul 18, 2025 · Artificial Intelligence

How AI Can Turn Codebases into Knowledge Graphs: A Practical Guide

An R&D newcomer struggles with undocumented code and hidden business rules, then builds a large-model-driven knowledge system that links code commits, requirement docs, and operational logs, enabling automated retrieval, intelligent prompts, and improved onboarding, illustrated through multi-stage implementation and practical API examples.

AIKnowledge ManagementSoftware engineering
0 likes · 12 min read
How AI Can Turn Codebases into Knowledge Graphs: A Practical Guide
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.

Best PracticesJavaNon-functional quality
0 likes · 19 min read
Non-Functional Quality Delivery and Code Documentation Practices
Java High-Performance Architecture
Java High-Performance Architecture
Feb 8, 2023 · R&D Management

Why Most Software Engineers Never Write Code From Scratch – The Realities You Need to Know

The article reveals that professional developers spend most of their time maintaining large codebases, navigating domain knowledge, writing documentation, handling incompetent teammates, assuming bugs, estimating work, and attending meetings, emphasizing that delivering business value outweighs writing elegant code.

Software engineeringcode documentationdeveloper life
0 likes · 13 min read
Why Most Software Engineers Never Write Code From Scratch – The Realities You Need to Know
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.

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