Add comments like table columns.

[biiiiiigmonster]

Summary

In order to better support ide, relations and getters/setters can also add comments like table columns. Only based on DocBlock, use @comment.#1165

Support list

• getter
• setter
• scope
• relations

Type of change

• New feature (non-breaking change which adds functionality)

Checklist

• Existing tests have been adapted and/or new tests have been added
• Add a CHANGELOG.md entry
• Update the README.md
• Code style has been fixed via composer fix-style

[mfn]

Despite you ticking off the checkbox, I don't see any tests:

Can you please add one before someone reviews the code?
Thank you!

[biiiiiigmonster]

I'm sorry that just did a local test, I'll make unit-test it up later.

[biiiiiigmonster]

@mfn I have committed the unit test code, please see if it meets the requirements.

[mfn]

What happens if both a getter and a setter has a @comment?

[biiiiiigmonster]

I'm not quite sure that you mean, i guess you mean when getter and setter have the same name?

If so, i just tested it, this property will not become two(@property-read&@property-write), but one(@property), and the
comment for this property will be anchoring the getter. If the getter doesn't have @comment, then this property don't either.

The simple code case

class User
{
    /**
     * @comment I'm a setter.
     */
    public function setFullNameAttribute(): void
    {}

    /**
     * @comment I'm a getter.(If I don't exist, so will the property)
     */
    public function getFullNameAttribute(): string
    {}
}

// =>

/**
 * @property string $full_name I'm a getter.(If I don't exist, so will the property)
 * …
 */

[mfn]

LGTM!

• I added a suggestion to improve the README
• change you please add a changelog entry?

[biiiiiigmonster]

OK, i got it :)