代码规范

代码规范
1 代码文件头注释 FileComment.snippet

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<?xml version="1.0" encoding="utf-8" ?>
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>FileComment</Title>
      <Description>Code snippet for generate file comment</Description>
      <Author>qiangguo</Author>
      <Shortcut>fc</Shortcut>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>classname</ID>
          <ToolTip>name of class</ToolTip>
          <Default>MyClass</Default>
        </Literal>
        <Literal>
          <ID>author</ID>
          <ToolTip>author</ToolTip>
          <Default>qiangguo</Default>
        </Literal>
        <Literal>
          <ID>version</ID>
          <ToolTip>version</ToolTip>
          <Default>1.0</Default>
        </Literal>
        <Literal>
          <ID>time</ID>
          <ToolTip>time of create file</ToolTip>
          <Default>2010-06-01</Default>
        </Literal>
      </Declarations>
      <Code Language="CSharp">
        <![CDATA[
#region File Comment
// +-------------------------------------------------------------------------+
// + Copyright (C), xxx Co., Ltd.
// +-------------------------------------------------------------------------+
// + FileName:$classname$.aspx.cs
// +-------------------------------------------------------------------------+
// + Author:$author$   Version:$version$   Date:$time$
// +-------------------------------------------------------------------------+
// + Description:
// +             $classname$定义
// +-------------------------------------------------------------------------+
// + History:
// +         <author>     <time>     <desc>
// +-------------------------------------------------------------------------+
#endregion
                ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

2 用Microsoft.StyleCop检查
去除以下规则
SA1630:A section of the Xml header documentation for a C# element does not contain any whitespace between words.
SA1632:A section of the Xml header documentation for a C# element is too short.
SA1200:A C# using directive is placed outside of a namespace element.

SA1633:A C# code file is missing a standard file header.

posted @   深潭  阅读(495)  评论(0编辑  收藏  举报
编辑推荐:
· Java 中堆内存和栈内存上的数据分布和特点
· 开发中对象命名的一点思考
· .NET Core内存结构体系(Windows环境)底层原理浅谈
· C# 深度学习:对抗生成网络(GAN)训练头像生成模型
· .NET 适配 HarmonyOS 进展
阅读排行:
· 手把手教你更优雅的享受 DeepSeek
· AI工具推荐:领先的开源 AI 代码助手——Continue
· 探秘Transformer系列之(2)---总体架构
· V-Control:一个基于 .NET MAUI 的开箱即用的UI组件库
· 乌龟冬眠箱湿度监控系统和AI辅助建议功能的实现
点击右上角即可分享
微信分享提示