From 0d70eda094d7b03f0deb08020018cd57220aed25 Mon Sep 17 00:00:00 2001 From: Marvin Schenkel Date: Thu, 29 Jan 2026 14:39:28 +0100 Subject: [PATCH] Add claude instructions about comment usage. --- CLAUDE.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 16d846a4..efe9e7fd 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -107,6 +107,21 @@ These demo/example implementations have a lot of docstrings and comments to help ## Code Style Guidelines +### Comments +Use comments wisely. Only use comments to explain a complex, multi-line block of code. + +**❌ Bad example** +```python +# add 1 and 2 together +add(1, 2) +``` + +**✅ Good example** +```python +# use xxx to achieve yyy +..multi line code block of complex code +``` + ### Docstring Format Music Assistant uses **Sphinx-style docstrings** with `:param:` syntax for documenting function parameters. This is the standard format used throughout the codebase. -- 2.34.1