Consistently format comments

php-fig / per-coding-style

PER coding style

262 stars 26 forks source link

Consistently format comments #75

Closed ravage84 closed 1 year ago

ravage84 commented 1 year ago

Capitalize beginning of all comments (regardless of keyword usage)
Replace "..." with "{context} body"
Use comment wording consistently & be specific for each use case
No periods or ellipses at the end of comments

I'll admit, this is nitpicking but it helps to think less about the comments when reading the specification.

KorvinSzanto commented 1 year ago

I agree these comments can be cleaned up and it might be good to do so. I'm not sure I agree with the choices here though, to me the // ... is the gold standard as opposed to something overly verbose like // Here lies a placeholder for class body content as the comments aren't really meant to be read, they are meant to act as a stand-in for code that would otherwise have to be dummy code.

ravage84 commented 1 year ago

I created an alternative to this PR that replaces all strucutre body comments with ellipsis: https://github.com/php-fig/per-coding-style/pull/79

Crell commented 1 year ago

Merged #79 instead, so closing this one.