zoukankan      html  css  js  c++  java
  • 代码规范

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

    <?xml version="1.0" encoding="utf-8" ?>
    <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
      <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.

  • 相关阅读:
    React性能优化记录(不定期更新)
    JSX设置CSS样式详解
    org.tinygroup.htmlparser-Html解析器
    org.tinygroup.application-应用启动框架
    org.tinygroup.beancontainer-IOC、AOP框架
    org.tinygroup.vfs-虚拟文件系统
    org.tinygroup.templateengine-模板引擎
    org.tinygroup.dbfilter
    org.tinygroup.templateweb-模板文件处理器
    org.tinygroup.flow-流程引擎
  • 原文地址:https://www.cnblogs.com/dbasys/p/1749326.html
Copyright © 2011-2022 走看看