Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get file header comments and similar up to date #539

Open
Moppa5 opened this issue Jun 11, 2021 · 1 comment
Open

Get file header comments and similar up to date #539

Moppa5 opened this issue Jun 11, 2021 · 1 comment

Comments

@Moppa5
Copy link
Contributor

Moppa5 commented Jun 11, 2021

Description
As a part of the cleanup project it was mentioned that Seravo Plugin contains a lots of outdated file header comments. There were lots of parts and code that was not documented before we run the rector. However, we should investigate and decide whether we remove those file header comments, versions etc. or get them up to date.

Personally I think that it would be nice to have method comments and documentation of every module or interface in general. On the other hand, I don't know how valuable the version of each module is? Could there be just general description of the class and its duties?

@Moppa5
Copy link
Contributor Author

Moppa5 commented Aug 2, 2021

#596 is related to this as it includes plenty of changes to the class comments. Most of the file headers contain now only the class comment and nothing more. As discussed I think we should stick with the class comments only. I don't think the separate version comments for each module do the job very well.

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

No branches or pull requests

2 participants