C#代码规范文档

ID：44266784

大小：138.00 KB

页数：8页

时间：2019-10-20

资源描述：

《C#代码规范文档》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、C#代码规范文档1方法注释规范1>C#捉供-•种机制，使程序员可以使用含有XML文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素牛成XMLo具体应用当中，类、接口、属性、方法必须有

节，另外方法如果冇参数及返回值，则必须有vPa⑻n>及节。示例如下：///

III...Ill

III///2>事件不需要头注解，但包含复杂处理时（如：循环/数据库操作/复杂

2、逻辑等），应分割成单一处理函数，事件再调用两数。3>所冇的方法必须在其定义前增加方法注释。4>方法注释采用///形式自动产生XML标签格式的注释。标记说明备注提供了一-种将说明中的文本标记为代码的方法提供了一种将多行指示为代码的方法可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到vcode>标记的使用。vexception>对可从当前编译环境中获取的异常的引用。vinclude>得以引用描述源代码中类型和成员的另一文件中的注释。用于定义表或定义列表中的标题行。川于诸如vsummary〉.或

3、等标记内，使您得以将结构添加到文本中。应当用于方法声明的注释中，以描述方法的一个参数。提供了一种指示词为参数的方法。vpermission>得以将成员的访问记入文档。vremarks>用于添加有关某个类熨的信息，从而补充山＜summary＞所指定的信息。vreturns>应当用于方法声明的注释，以描述返回值。得以从文木内指定链接。对可以通过当前编译坏境进行调用的成员或字段的引用。

应当用于描述类型或类熨成员。得以描述属性。示例图如2III///祓用心
4、5计算哈希散列//////III^f
5、&///t)n密后的字符串publicstaticstringEncr^tMDS(stringstrScurcerstringstrSaltCcde){//md5加密服务对象System.Security.Cryptography.MD5CryptcServiceProvidermd5=newSystem.Security.Crypt
6、ography.MD5CryptcServiceProvider();byte[]bytValue;byte[]bytHash;5＞在公用类库中的公用方法需要在一般方法的注释后添加作者、日期及修改记录信息，统一采用XML标签的格式加注，标签如下：作者建立口期修改记录修改作者修改H期修改理由
7、yBy>修改作者修改H期修改理11
8、修改作者修改日期修改理由最后修改H期6>一个代码文件如果是由一人编写，则此代码文件中的方法无需作者信息，非代码文件作者在此文件中添加方法时必须要添加作者、H期等注释。7>修改任何方法，必须要添加修
9、改记录的注释。2代码行注释规范1>如果处理某一个功能需要很多行代码实现，并且有很多逻辑结构块，类似此种代码应该在代码开始前添加注释，说明此块代码的处理思路及注意事项等2>注禅从新行增加，与代码开始处左对齐3>双斜线与注禅Z间以空格分开，示例图如下所示:{//如果事务开启过，则释放事务对象if(this.IDbTrans!=null)thi3•IDbTrans.Dispose();//如果连接已经打开，则关闭连接井释放资源if(this.IDbConn.State==CcnnecticnState.Op-


                        
                             当前文档最多预览五页，下载文档查看全文  
                            
                                
                                    
                                        
                                             侵权申诉 
                                            
                                        
                                        
                                            
                                            
                                                1
                                                                                                                                                            1
                                                                                                            2
                                                                                                            3
                                                                                                            4
                                                                                                            5
                                                                                                        / 8
                                                                                            
                                            
                                        
                                    
                                    
                                        此文档下载收益归作者所有
                                        
                                    
                                
                            
                        
                        当前文档最多预览五页，下载文档查看全文


            
                
                    
                        版权提示
                    
                    
                        下载文档
                    
                    
                        
                            
                        
                    
                
                
                    
                        温馨提示： 

                        1. 部分包含数学公式或PPT动画的文件，查看预览时可能会显示错乱或异常，文件下载后无此问题，请放心下载。

                        2. 本文档由用户上传，版权归属用户，天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。

                        3. 下载前请仔细阅读文档内容，确认文档内容符合您的需求后进行下载，若出现内容与标题不符可向本站投诉处理。

                        4. 下载文档时可能由于网络波动等原因无法下载或下载错误，付费完成后未能成功下载的用户请联系客服处理。

C#代码规范文档

C#代码规范文档

相关文章

相关标签