注释

1.Python

    1、单行注释：# 注释内容

    2、多行注释: ''' 注释内容 ''' 或者 """ 注释内容 """

    3、中文注释：从Python3开始，Python默认使用UTF-8编码，所以Python3.x的源文件不需要特殊声明UTF-8编码。

                  # -*- coding: UTF-8 -*-  
          
print ("你好，Python")

    4、平台注释：如果需要使Python程序运行在Windows以外的平台上(linux)，需要在Python文件的最前面加上如下注释说明。

          #! /usr/bin/python  它是用来指定用什么解释器运行脚本以及解释器所在的位置

   5、文档注释：在py文件的最上面注释，可以使用help查看到注释的内容。

   6、函数注释：在函数def的下面注释。

'''
    py文件的说明：
    函数的定义和调用
'''
#!/usr/bin/python
#-*- encoding:UTF-8 -*-
def numMax(a,b):
    '''
        函数的说明：
            函数的第一行语句可以选择性地使用文档字符串—用于存放函数说明。
            return 表达式 结束函数，选择性的返回一个值给调用方。
            不带表达式的return相当于返回 None。
        求两个数字的最大值。
    '''
    ret = a
    if ret < b:
        ret = b
    return ret

print(numMax(30,20))

  

      

2.Java

        1、单行(single-line)注释：//……

        2、块(block)注释：/*……*/

        3、文档注释：/**……*/

        4、javadoc 注释标签语法

            @author   对类的说明 标明开发该类模块的作者

            @version   对类的说明 标明该类模块的版本

            @see     对类、属性、方法的说明 参考转向，也就是相关主题

            @param    对方法的说明 对方法中某参数的说明

            @return   对方法的说明 对方法返回值的说明

             @exception  对方法的说明 对方法可能抛出的异常进行说明

3.PHP

    php注释规范

    注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范。

    php里面常见的几种注释方式：

    1.文件头的注释，介绍文件名，功能以及作者版本号等信息

    /**
    *文件名简单介绍
    *
    *文件功能。
    * @author      alvin 作者
    * @version     1.0 版本号
    */
    
    2.函数的注释，函数作用，参数介绍及返回类型

    /**  
    * 函数的含义说明
    *
    * @access public
    * @param mixed $arg1 参数一的说明
    * @param mixed $arg2 参数二的说明
    * @param mixed $mixed 这是一个混合类型
    * @return array 返回类型
    */  
    
    3.类的注释，类名及介绍

    /**
    * 类的介绍
    *
    * 类的详细介绍（可选。）。
    * @author      alvin 作者
    * @version     1.0 版本号
    */
    4.多行注释

    /* php注释语法
       这是多行注释。*/

    5.单行注释

    $n = 10; //数量n，这是单行注释