zoukankan      html  css  js  c++  java
  • 代码书写之注释规范性

    在类名的前面对整个类进行说明:

     1 /* *
     2  *类名:AlipayFunction
     3  *功能:支付宝接口公用函数类
     4  *详细:该类是请求、通知返回两个文件所调用的公用函数核心处理文件,不需要修改
     5  *版本:3.3
     6  *日期:2012-08-14
     7  *说明:
     8  *以下代码只是为了方便商户测试而提供的样例代码,商户可以根据自己网站的需要,按照技术文档编写,并非一定要使用该代码。
     9  *该代码仅供学习和研究支付宝接口使用,只是提供一个参考。
    10  */
    View Code

    在类内的每一个函数前面进行说明:

    1   /** 
    2      * 生成文件摘要
    3      * @param strFilePath 文件路径
    4      * @param file_digest_type 摘要算法
    5      * @return 文件摘要结果
    6      */
    View Code

    另外在关键代码出也要用注释进行说明。

  • 相关阅读:
    Java第一次作业
    第十一次作业
    第十次作业
    第九次作业
    第五次作业
    第四次作业
    第三次作业
    第二次作业
    Java23种设计模式
    第三次作业
  • 原文地址:https://www.cnblogs.com/dobestself-994395/p/4321018.html
Copyright © 2011-2022 走看看