Skip to content

Remove "separator" comment between function declarations? #2146

Description

@andreportaro

Hi all,

These comments appear throughout the codebase, and to me it is unclear why it is necessary.

	//--------------------------------------------------------------------

Some classes with only one method will use it:

//--------------------------------------------------------------------

Others won't:

public function shouldDiscover(string $alias)

The styleguide does not directly mention where or why such comment would be needed, but it does include one such "separator" on the docblock section.

I feel like it only adds visual bloat and the line breaks between function declarations should already be good enough visual cues, therefore such comments shouldn't be necessary.

I'm happy to create a PR for this if it's agreed upon.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions