Tag

Comments

1 views collected around this technical thread.

Code Mala Tang
Code Mala Tang
Jun 6, 2025 · Fundamentals

Master Python Comments: Best Practices and Common Pitfalls

This guide explains what comments are in Python, shows how to write single‑line and multi‑line comments using the # symbol, warns against misuse of triple quotes, covers docstring usage, and provides IDE shortcut keys for efficient commenting.

Best PracticesCommentsDocstrings
0 likes · 7 min read
Master Python Comments: Best Practices and Common Pitfalls
Java Tech Enthusiast
Java Tech Enthusiast
Oct 26, 2024 · Fundamentals

12 Coding Habits That Reduce Code Readability and Increase Maintenance Difficulty

The article outlines twelve harmful coding habits—such as excessive microservice splitting, incomplete refactoring, overly long methods, deep nesting, random variable names, inaccurate or outdated comments, duplicated code, ignoring specifications, missing logging, over‑engineered frameworks, and reinventing wheels—that degrade readability, complicate maintenance, increase bugs, and hurt team productivity.

CommentsFrameworksMicroservices
0 likes · 9 min read
12 Coding Habits That Reduce Code Readability and Increase Maintenance Difficulty
JD Retail Technology
JD Retail Technology
Oct 19, 2023 · Fundamentals

Java Naming Conventions, Code Comments, and Advanced Language Features

This article explores the trade‑offs between efficiency, readability and maintainability in software development, presents common naming conventions and best‑practice guidelines for Java, discusses proper use of comments, and introduces advanced language constructs such as records, sealed classes and the upcoming Valhalla project.

CommentsImmutable ObjectsJava
0 likes · 29 min read
Java Naming Conventions, Code Comments, and Advanced Language Features
360 Tech Engineering
360 Tech Engineering
Dec 28, 2020 · Frontend Development

High‑Performance Comment Integration for Static Hugo Blogs Using getJSON and Waline

This guide explains how to embed dynamic comments into a static Hugo blog by leveraging Hugo's getJSON function, the Waline comment service, and Vercel deploy hooks to fetch, render, and update comment data during site builds, achieving fast, cache‑friendly performance without sacrificing user experience.

Build HooksCommentsVercel
0 likes · 9 min read
High‑Performance Comment Integration for Static Hugo Blogs Using getJSON and Waline
Continuous Delivery 2.0
Continuous Delivery 2.0
May 10, 2020 · Fundamentals

Eliminating YAGNI Smell, When to Use Comments, and Effective Code Review Practices

This article explains how to identify and remove YAGNI code smells, discusses when comments are helpful versus harmful, and provides practical guidelines for conducting efficient code reviews to improve software quality and maintainability.

Code ReviewCommentsYAGNI
0 likes · 9 min read
Eliminating YAGNI Smell, When to Use Comments, and Effective Code Review Practices
Python Programming Learning Circle
Python Programming Learning Circle
Mar 28, 2020 · Fundamentals

Writing Clean Code: Naming, Comments, Functions, and Testing Best Practices

The article explains how to write clean, expressive code by defining dirty versus clean code, presenting expert guidelines on naming, commenting, function design, and testing, and illustrating each point with concrete good and bad code examples.

CommentsFunctionsNaming
0 likes · 11 min read
Writing Clean Code: Naming, Comments, Functions, and Testing Best Practices