Skip to content

Code Documentation - Format Demonstration#1

Open
Dawilly wants to merge 4 commits into
mainfrom
code_documentation
Open

Code Documentation - Format Demonstration#1
Dawilly wants to merge 4 commits into
mainfrom
code_documentation

Conversation

@Dawilly

@Dawilly Dawilly commented Jan 30, 2025

Copy link
Copy Markdown
Owner

This PR is nothing more than to quickly discuss the style and/or formatting of the code documentation.

Looking for feedback on phrases, verbiage, and what should be documented alongside formatting and style.

Currently, the following are to be documented with XML-style documentation:

  • Public Properties/Methods/Fields
  • Protected Properties/Methods/Fields that are NOT apart of a sealed class.

For Formatting the following is what is currently in mind:

  • Tabs over spaces (as set in Moonworks)
  • Allman Indentation
  • File-scope Namespacing
  • Breaks between groups of using declarations at the top.
  • Explicit accessible type

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant