Require documentation for non Public-APIs as well

[Nigusu-Allehu]

Bug

Fixes:

Description

This PR updates our documentation guidelines to improve code clarity and maintainability:

Non-Public Methods:

• Documentation is required for non-public methods longer than 15 lines or those with complex logic.
• Methods shorter than 15 lines but with intricate logic must also be documented.

Benefits:

• Enhances code clarity and maintainability.
• Reduces ambiguity and aids future developers.
• Makes code review process faster
• Encourages code reviewing by making the changes more clearer

Draw backs:

• Documentation overhead

PR Checklist

• Meaningful title, helpful description and a linked NuGet/Home issue
• Added tests
• Link to an issue or pull request to update docs if this PR changes settings, environment variables, new feature, etc.

[Nigusu-Allehu]

Please feel free to discuss what you think. This is just an idea I had after meeting some, in order to understand, time taking/ complex private methods. I understand this could also result in a documentation overhead. However, I believe the benefit might out weight it.

[Nigusu-Allehu]

After some discussion with @kartheekp-ms :
While documenting complex private methods is useful, it often highlights the need for refactoring. Complex methods should be broken down into simpler, more manageable pieces.

Instead of focusing just on documentation, let's aim to write methods that are clear from the start. This could be done through good naming and refactoring.

[dotnet-policy-service]

This PR has been automatically marked as stale because it has no activity for 7 days. It will be closed if no further activity occurs within another 7 days of this comment. If it is closed, you may reopen it anytime when you're ready again, as long as you don't delete the branch.