Skip to content

Consistently format comments#75

Closed
ravage84 wants to merge 2 commits intophp-fig:masterfrom
ravage84:consitent-comments
Closed

Consistently format comments#75
ravage84 wants to merge 2 commits intophp-fig:masterfrom
ravage84:consitent-comments

Conversation

@ravage84
Copy link
Copy Markdown
Contributor

@ravage84 ravage84 commented Jun 1, 2023

  • 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.

- 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
@KorvinSzanto
Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Member

@samdark samdark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 except @KorvinSzanto comments

ravage84 added a commit to ravage84/per-coding-style that referenced this pull request Jun 5, 2023
- Capitalize beginning of all comments
- No periods at the end of comments

As an alternative to php-fig#75.
@ravage84
Copy link
Copy Markdown
Contributor Author

ravage84 commented Jun 5, 2023

I created an alternative to this PR that replaces all strucutre body comments with ellipsis: #79

@Crell
Copy link
Copy Markdown
Collaborator

Crell commented Jun 6, 2023

Merged #79 instead, so closing this one.

@Crell Crell closed this Jun 6, 2023
@ravage84 ravage84 deleted the consitent-comments branch June 6, 2023 16:25
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.

4 participants