Skip to content

Comments: single-line lowercase standard across every language - #32

Merged
paulocoutinhox merged 1 commit into
mainfrom
comment-normalization
Jul 27, 2026
Merged

paulocoutinhox merged 1 commit into
mainfrom
comment-normalization

Conversation

@paulocoutinhox

Copy link
Copy Markdown
Contributor

Comments were only compliant in C++; CMake, Makefile, Swift, Kotlin, and Dart still had capitalized comments, ==== banners, semicolon-split sentences, and run-on multi-line comments. This normalizes them everywhere to the project standard: one line, lowercase, one objective sentence, no ;, no banner separators.

Changes

  • C++: rewrite the 37 semicolon-split comments into one objective sentence, collapse the multi-line/run-on comments that continued a sentence across lines, lowercase the two posix #else labels
  • CMake: lowercase comments, drop the banner separator, condense the embed-resources header block and generated-file markers
  • Makefile: remove the ==== section banners, lowercase the section labels and header
  • Swift / Kotlin / Dart: drop semicolons and run-ons, remove leftover template boilerplate, lowercase stray capitalized comments
  • CLAUDE.md: state the comment rules apply to every language (// and #)

Validation

  • make build green, all 151 tests pass
  • make help parses; no C++/behaviour changes (comments only)
  • Kept justified exceptions: the public ionclaw.h C ABI contract docs and /*param*/ unused-parameter markers

🤖 Generated with Claude Code

…guage

Normalize comments to the project standard everywhere, not just C++:

- C++: rewrite the 37 comments that split a sentence with a semicolon into
  one objective sentence, collapse the multi-line and run-on comments that
  continued a sentence across lines, and lowercase the two posix #else labels
- CMake: lowercase the comments, drop the banner separator, and condense the
  embed-resources header block and generated-file markers
- Makefile: remove the ==== section banners and lowercase the section labels
  and header
- Swift, Kotlin, Dart: drop the semicolons and run-ons, remove leftover
  template boilerplate, and lowercase the stray capitalized comments

Document in CLAUDE.md that the comment rules apply to every language.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@paulocoutinhox
paulocoutinhox merged commit e0ae62a into main Jul 27, 2026
6 checks passed
@paulocoutinhox
paulocoutinhox deleted the comment-normalization branch July 27, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant