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

Code Quality: Continued work to clean up entire project #12340

Closed
0x5bfa opened this issue May 12, 2023 · 6 comments
Closed

Code Quality: Continued work to clean up entire project #12340

0x5bfa opened this issue May 12, 2023 · 6 comments
Assignees

Comments

@0x5bfa
Copy link
Member

0x5bfa commented May 12, 2023

Description

This is a milestone to display what PR is related the cleaning-up plan. Rationale is that Files source codebase don't have consistency. All of us absolutely must be forced to follow the guideline to keep code clean. I will clean up the project with the strict order I defined so that I would not break any existing functionalities.

Concerned code

I have following stages to clean up:

  1. Rename files with the appropriate name and put them into appropriate namespace for each.
  2. Rename variables with preferred name to follow the guideline (The most likely to happen is that I rename property-backing-field from '_isHidden' to '_IsHidden')
  3. Reorder variables & methods to follow the class structure guideline (Section 3 in the guildeline)
  4. Add/Update/Improve C# XML Comments and double-slashed comments.
  5. Refactor to improve performance. You can see what I will work on in Requirements section.
  • Files.App.**
  • Files.Shared
  • Files.Backend

Gains

  • A better readability.
  • A better maintainability.
  • Faster build of Files.App

Requirements

  • Force to follow the guideline in anyway
  • Add sealed accessor to entire Files.App except classes from which other classes have to be deriven.
  • Add internal accessor to entire Files.App
  • Append Async to the end of async method name
  • Add init accessor to properties which have to be readonly
  • Use Utils namespace for utilities, manangers, and watchers
  • Use Lazy class for delay initialization
  • Avoid boxing

Comments

No response

@yaira2
Copy link
Member

yaira2 commented May 12, 2023

Append Async to the end of async method name

This is already being worked on

@yaira2
Copy link
Member

yaira2 commented May 12, 2023

Entire project

How do you want to split this up?

@0x5bfa
Copy link
Member Author

0x5bfa commented May 12, 2023

This is already being worked on

I will mention the PR after opened.

How do you want to split this up?

I just opened a PR for Files.App.ViewModels. Splitting into each folder in Files.App

@JaiganeshKumaran
Copy link
Contributor

The most likely to happen is that I rename property-backing-field from '_isHidden' to '_IsHidden'
I don't this is the recommended convention.

@0x5bfa
Copy link
Member Author

0x5bfa commented May 15, 2023

Please note that this issue's purpose is to force codebase to follow the guideline for great consistency.

from '_isHidden' to '_IsHidden'

This is on the guideline. Can you open an issue for that?

@yaira2
Copy link
Member

yaira2 commented Jul 30, 2023

Merging with #4180

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

No branches or pull requests

3 participants