This is an automated email from the ASF dual-hosted git repository.
FreeAndNil pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4net.git
The following commit(s) were added to refs/heads/master by this push:
new bc834dc2 require short comments
bc834dc2 is described below
commit bc834dc2c3230c94cad2ae9ce9c29a0ab6ac412c
Author: Jan Friedrich <[email protected]>
AuthorDate: Tue Sep 1 21:39:10 2026 +0200
require short comments
The most common correction in review, and not derivable from the sources,
where
long remarks do exist.
---
CLAUDE.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/CLAUDE.md b/CLAUDE.md
index 1b008575..ecbe7c6a 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -118,6 +118,10 @@ almost always be doing.
not exist on `net462`/`netstandard2.0`, so use `TaskCompletionSource<bool>`.
### Documentation comments
+- **Keep them short.** A doc comment is one or two sentences, an inline
comment is one line. If a
+ remark wants a second paragraph, the reason belongs in the commit message or
the changelog, not
+ in the source. Say what the code does not already say, then stop. This is
the single most common
+ correction made in review, so err shorter than feels right.
- **Every public and protected member gets an XML doc comment**, in test code
as well as production
code: test methods, nested helper classes and hand-written fakes included.
- Use `/// <inheritdoc/>` when the member implements an interface or overrides
a base member, and a
