代码规范
代码规范
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.
作者:深潭
出处:http://www.cnblogs.com/dbasys/
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
出处:http://www.cnblogs.com/dbasys/
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· Java 中堆内存和栈内存上的数据分布和特点
· 开发中对象命名的一点思考
· .NET Core内存结构体系(Windows环境)底层原理浅谈
· C# 深度学习:对抗生成网络(GAN)训练头像生成模型
· .NET 适配 HarmonyOS 进展
· 手把手教你更优雅的享受 DeepSeek
· AI工具推荐:领先的开源 AI 代码助手——Continue
· 探秘Transformer系列之(2)---总体架构
· V-Control:一个基于 .NET MAUI 的开箱即用的UI组件库
· 乌龟冬眠箱湿度监控系统和AI辅助建议功能的实现