代码乱如三国,急需要治理

简介:   代码风格乱如三国,代码注释千奇百怪,让人无法接受与阅读。C\C++\c#\qt\Java\vb等这些大语言们,得想法个规范其注释。  得出下面的千古规范:1、单行注释   因为注释文字不多,尽量建议放在代码行的右边,增加代码可阅读性。


  代码风格乱如三国,代码注释千奇百怪,让人无法接受与阅读。C\C++\c#\qt\Java\vb等这些大语言们,得想法个规范其注释。


  得出下面的千古规范:


1、单行注释

   因为注释文字不多,尽量建议放在代码行的右边,增加代码可阅读性。


(1) 注释放在右边,"//" 注释符类型

string AppStartupPath;           // 取得应用程序的路径 

(2)注释放在右边," /* */ " 注释符类型

this.dataGridView1.Rows.RemoveAt(0);   /*  删除单元格 */


img_c76d621d732689cad9aeb7ecaeada4dc.jpg

                        图1 避免注释影响代码可阅读性

2、多行注释

/*

*    这

*    是多行注释

*/


3、注释放在要注释语句的上面时,其上面使用空行隔开,避免拥挤。


image

                                 图2 我的注释样式举例


image

                              图3 VS2008最佳显示字体与大小


4、代码语句之间,满四句就空两格


  1. [DllImport("kernel32")]

  2.         private static extern int GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);

  3.         [DllImport("kernel32")]

  4.         private static extern int GetPrivateProfileString(string section, string key, string def, byte[] bufferRe, uint size, string filePath);



  5.         public string RemoteIP;

  6.         public int RemotePort;

  7.         public begin Begin;

  8.         public Register register;



  9.         public delegate void RefreshLabel();

  10.         private Liststring> InternalInfoList;

  11.         private Liststring> DynamicMessList;

  12.         private BackgroundWorker InitialSystemWorker;

5、上、下函数之间,空三格


  1. private void funA()
  2. {
  3. ///
  4. }

  5. /** 这里请空三格*/

  6. private void funB()
  7. {
  8. ///
  9. }


相关文章
|
2月前
|
数据采集 存储 监控
CDGA|做好数据治理的几个策略,不看后悔
做好数据治理是企业实现数字化转型和智能化升级的关键。通过明确目标、建立组织、制定标准、实施质量管理、促进共享与协作以及持续优化与迭代等策略,企业可以构建完善的数据治理体系,提升数据价值,为业务决策提供有力支持。在未来的发展中,数据治理将成为企业核心竞争力的重要组成部分。
|
6月前
|
前端开发 Java Spring
公司这套架构统一处理 try...catch 这么香,求求你不要再满屏写了,再发现扣绩效!
公司这套架构统一处理 try...catch 这么香,求求你不要再满屏写了,再发现扣绩效!
32 0
|
移动开发 Java Android开发
复盘:细数这些年写文字的成与败
我仍然认为文字有它特殊的魅力,文字能够被反复琢磨,能够带来不一样的感受,在碎片化的时代我们仍然需要一种情绪上的出口,细腻的文字能让人获得更多的能量。
98 0
复盘:细数这些年写文字的成与败
|
区块链 算法框架/工具 Android开发
Stepn跑鞋零撸项目开发详情丨Stepn跑鞋零撸项目系统开发(案例设计)及代码说明
简单说,智能合约是一种用计算机语言取代法律语言去记录条款的合约。智能合约可以由一个计算系统自动执行。可以理解为智能合约就是传统合约的数字化版本。
新增节添加代码【滴水逆向三期46笔记】
新增节添加代码【滴水逆向三期46笔记】
|
XML Java 数据格式
从非诚勿扰看数据索引,优化代码小妙招
从非诚勿扰看数据索引,优化代码小妙招
147 0
|
弹性计算 关系型数据库 Java
个人工作总结无代码-三分白
个人工作总结无代码-三分白
442 0
|
新零售 人工智能 大数据
二二复制公排互助系统丨二二复制公排互助系统开发(开发规则)丨二二复制公排互助开发成品源码
 新零售即基于互联网的个人和企业,通过利用大数据、人工智能等先进技术和心理知识,升级商品的生产、流通和销售流程,重塑业务结构和生态系统,深入整合线上服务、线下体验和现代物流的新零售模式。线上和线下物流的结合将产生新零售。
|
NoSQL Java Redis
【日拱一卒进击大厂系列】如何写好一份技术简历
【日拱一卒进击大厂系列】如何写好一份技术简历
【日拱一卒进击大厂系列】如何写好一份技术简历
|
消息中间件 设计模式 前端开发
公司这套架构统一处理try...catch这么香,求求你不要再满屏写了,再发现扣绩效!
软件开发springboot项目过程中,不可避免的需要处理各种异常,spring mvc 架构中各层会出现大量的try {...} catch {...} finally {...} 代码块,不仅有大量的冗余代码,而且还影响代码的可读性。这样就需要定义个全局统一异常处理器,以便业务层再也不必处理异常。
公司这套架构统一处理try...catch这么香,求求你不要再满屏写了,再发现扣绩效!