Skip to main content

A tool to check code comment format

Project description

comment-format

A tool to check code comments format.

Supported features

Comment style

By default the tool will warn if a comment is not following the desired language style.

The tool can also automatically fix the comment style.

Comment spelling

The tool will warn if any spelling mistake is found in a comment (no matter the style)

Supported languages

  • C
  • C++

Installation

$ pip install comment-format

Usage

$ comment-format --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

comment_format-0.1.3.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

comment_format-0.1.3-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file comment_format-0.1.3.tar.gz.

File metadata

  • Download URL: comment_format-0.1.3.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for comment_format-0.1.3.tar.gz
Algorithm Hash digest
SHA256 edc2082f36a816b925bc44e362a56748ea4c8b2b8b3a4d87caf66cdf56eecb38
MD5 e10ec240e6acb4ca029457834b8a779b
BLAKE2b-256 11a2b0bebd1ca45b97e2ac5ea205e8e9b03cb84ed731cadbccf4e87a0f077ac3

See more details on using hashes here.

Provenance

The following attestation bundles were made for comment_format-0.1.3.tar.gz:

Publisher: release.yml on AlexFabre/comment-format

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file comment_format-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: comment_format-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for comment_format-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bf36cd689142e70ef35eddb4e16e2404a644b98c801c90d1204250b48c501bdc
MD5 655d8374dbab177a8991f4c1f2c27595
BLAKE2b-256 aa4df4c5eb3a9602e8f6287248280e7fa0f5ec96ca3b47b1acc70d7b2bfc7396

See more details on using hashes here.

Provenance

The following attestation bundles were made for comment_format-0.1.3-py3-none-any.whl:

Publisher: release.yml on AlexFabre/comment-format

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page