microsoft / microsoft/WindowsAppSDK-Samples
Recommend using #region in samples to comment the code
Open
Nobody has claimed this yet.
documentation
- Dominant language
- PowerShell
- Stars
- 1k
- Forks
- 335
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 8
Description
Add guidelines/recommendations for sample authors to use #region to mark their code so that customers can easily find the right places to go to. In Visual Studio you can expand/minimize the regions to view the code in each section.
For example: #region Constructor, lifecycle and navigation
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the sample-author guidelines or documentation area and review how recommendations for sample structure are presented. Add guidance to use #region markers, including the example shown in the issue, and confirm the recommendation is visible to sample authors.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100