Skip to content

Instantly share code, notes, and snippets.

@mfoda

mfoda/Nez_Naming_Conventions

Created February 14, 2017 03:14
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save mfoda/708a356d49febbb8889e5862f07b3403 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save mfoda/708a356d49febbb8889e5862f07b3403 to your computer and use it in GitHub Desktop.
Download ZIP
A Nez naming convention Policy file for use with Xamarin Studio and Visual Studio
Raw
Nez_Naming_Conventions
<?xml version="1.0" encoding="utf-8"?>
<PolicySet name="Nez Internal Naming Conventions">
<TextStylePolicy inheritsSet="Mono" inheritsScope="text/plain" scope="text/plain" />
<XmlFormattingPolicy inheritsSet="Mono" inheritsScope="application/xml" scope="application/xml" />
<VersionControlPolicy inheritsSet="Mono" />
<CSharpFormattingPolicy inheritsSet="Mono" inheritsScope="text/x-csharp" scope="text/x-csharp" />
<NameConventionPolicy>
<Rules>
<NamingRule>
<Name>Namespaces</Name>
<AffectedEntity>Namespace</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Types</Name>
<AffectedEntity>Class, Struct, Enum, Delegate</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Interfaces</Name>
<RequiredPrefixes>
<String>I</String>
</RequiredPrefixes>
<AffectedEntity>Interface</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Attributes</Name>
<RequiredSuffixes>
<String>Attribute</String>
</RequiredSuffixes>
<AffectedEntity>CustomAttributes</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Event Arguments</Name>
<RequiredSuffixes>
<String>EventArgs</String>
</RequiredSuffixes>
<AffectedEntity>CustomEventArgs</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Exceptions</Name>
<RequiredSuffixes>
<String>Exception</String>
</RequiredSuffixes>
<AffectedEntity>CustomExceptions</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Methods</Name>
<AffectedEntity>Methods</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Static Readonly Fields</Name>
<AffectedEntity>ReadonlyField</AffectedEntity>
<VisibilityMask>Internal, Protected, Public</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>False</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Fields (Non Private)</Name>
<AffectedEntity>Field</AffectedEntity>
<VisibilityMask>Internal, Protected, Public</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>ReadOnly Fields (Non Private)</Name>
<AffectedEntity>ReadonlyField</AffectedEntity>
<VisibilityMask>Internal, Protected, Public</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>False</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Fields (Private)</Name>
<AllowedPrefixes>
<String>_</String>
<String>m_</String>
</AllowedPrefixes>
<AffectedEntity>Field, ReadonlyField</AffectedEntity>
<VisibilityMask>Private</VisibilityMask>
<NamingStyle>CamelCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>False</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Static Fields (Private)</Name>
<AffectedEntity>Field</AffectedEntity>
<VisibilityMask>Private</VisibilityMask>
<NamingStyle>CamelCase</NamingStyle>
<IncludeInstanceMembers>False</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>ReadOnly Fields (Private)</Name>
<AllowedPrefixes>
<String>_</String>
<String>m_</String>
</AllowedPrefixes>
<AffectedEntity>ReadonlyField</AffectedEntity>
<VisibilityMask>Private</VisibilityMask>
<NamingStyle>CamelCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>False</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Constant Fields</Name>
<AffectedEntity>ConstantField</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Properties</Name>
<AffectedEntity>Property</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Events</Name>
<AffectedEntity>Event</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Enum Members</Name>
<AffectedEntity>EnumMember</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Parameters</Name>
<AffectedEntity>Parameter</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>CamelCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
<NamingRule>
<Name>Type Parameters</Name>
<RequiredPrefixes>
<String>T</String>
</RequiredPrefixes>
<AffectedEntity>TypeParameter</AffectedEntity>
<VisibilityMask>VisibilityMask</VisibilityMask>
<NamingStyle>PascalCase</NamingStyle>
<IncludeInstanceMembers>True</IncludeInstanceMembers>
<IncludeStaticEntities>True</IncludeStaticEntities>
</NamingRule>
</Rules>
</NameConventionPolicy>
<TextStylePolicy inheritsSet="VisualStudio" inheritsScope="text/plain" scope="text/x-fsharp">
<FileWidth>120</FileWidth>
<NoTabsAfterNonTabs>True</NoTabsAfterNonTabs>
</TextStylePolicy>
</PolicySet>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment