IntelliTect / IntelliTect/CodingGuidelines

Do use file-based namespace declarations.

Open
#189 0 comments 0 reactions 0 assignees View on GitHub
C# coding guidelines proposal
Dominant language
C#
Stars
12
Forks
16
Avg merge
2m
Merged PRs (30d)
7

Description

The only reason to use scoped-based namespace declarations is when there is more than one namespace define in a file. Since this condition should be avoided in production code, I propose the guideline: Do use file-based namespace declarations.

This wording, however, may not be clear enough. Perhaps Do use file-based namespace declarations and avoid scope-based namespace declarations.

I suspect that over time scope-based namespace declarations will disappear except in legacy code.

Contributor guide

Open the contributing guide

Research direction

No file or test is named. Locate the guideline covering namespace declarations, compare its current wording with the proposed file-based preference, and update the guidance so the distinction from scope-based declarations is unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.