C# 提供一种机制，使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML。使用这类语法的注释称为文档注释(documentation comment)。这些注释后面必须紧跟用户定义 ...

为什么要写注释？ 早上我写完了代码，我和我的朋友们都能看懂，到了晚上，我还能看懂，一周后，就只有上帝能看懂了…… 将来我们写的代码量是很大的，代码又不像我们自然语言这么好理解，可能过段时间我们就不认识自己的代码了，所以我们要养成写注释的好习惯。 团队合作当中，写了注释更容易 ...

基本语法 注释代码以/开始，以/结束 注释不能嵌套 示例 /* 注释内容 */ 团队约定 注释内容 *对于一般性注解，书写简单的短语；对于较长的注解，书写完整的句子。 推荐写法 /* 用户头像 */ .avatar { width: 200rpx; height ...

注释 代码是由人编写并维护的，我们要尽可能保证写的代码能够自描述、注释良好并且易于他人理解。好的注释能够传达上下文关系和代码目的。 注释代码以结尾。 标准写法 错误写法 <!--> 动态列表 --> <!---> 动态列表 <--> ...

01.安全设计Checklist 输入验证 校验跨信任边界传递的不可信数据(策略检查数据合法性，含白名单机制等)格式化字符串时，依然要检验用户输入的合法性，避免可造成系统信息泄露或者拒绝服 ...

标签 小程序视图层开发基于小程序框架为开发者提供的一系列基础组件，这些基础组件通常以双标签或单标签的形式使用。 双标签包括起始标签<标签>，结止标签</标签>和属性， ...

所有类或者方法都添加文档注释，而自己总容易忘记添加或者漏添加的话。可以试试这个办法： 在项目上右键-- ...

C#文档注释格式： /// <summary> /// function description /// </summary> /// <param name="para1"></param> /// <param name="para2 ...