支持语言

支持注释格式：

支持语言：

• /**/形式：Javascript/Java/go/C++/C/php/ rust/solidity

• '''形式：python

• <!-- -->形式：html、vue、markdown

• '形式： vba

• #形式: shellscript

• --[[--]]形式: lua

函数注释自动提取函数的参数

使用效果:

目前支持函数参数自动提取的文件后缀：

• javascript： js、html、vue、jsx
• ts : tsx、ts
• go: go
• java
• python: py
• php
• c: c、c++、h、cc、cpp、cxx
• rust
• solidity

自定义注释符号：

详情查看插件配置,不支持的注释形式，自定义也能使用！

示例设置：

"fileheader.customMade": {
    "Description": "",
    "Author": "OBKoro1",
    "Github": "https://github.com/OBKoro1",
    "Date": "Do not edit",
    "LastEditors": "OBKoro1",
    "LastEditTime": "Do not edit"
},
"fileheader.cursorMode": {
    "description": "",
    "param": "",
    "return": ""
},

/**/形式

默认情况下，将生成/**/形式的注释，此形式注释支持Javascript/Java/go/C++/C/ php语言：

• 头部注释

    /*
     * @Description: 
     * @Author: OBKoro1
     * @Github: https://github.com/OBKoro1
     * @Date: 2018-09-27 13:55:00
     * @LastEditors: OBKoro1
     * @LastEditTime: 2018-11-08 16:10:19
     */
  

• 函数注释

    /**
     * @description: 
     * @param {type} 
     * @return: 
     */
  

'''形式:

• 头部注释

    '''
    @Description: 
    @Author: OBKoro1
    @Github: https://github.com/OBKoro1
    @Date: 2018-10-24 21:57:52
    @LastEditors: OBKoro1
    @LastEditTime: 2018-11-08 16:15:14
    '''
  

• 函数注释

    '''
    @description: 
    @param {type} 
    @return: 
    '''
  

<!-- -->形式:

• 头部注释

    <!--
    * @Description: 
    * @Author: OBKoro1
    * @Github: https://github.com/OBKoro1
    * @Date: 2018-11-16 14:38:05
    * @LastEditors: OBKoro1
    * @LastEditTime: 2018-11-19 14:32:45
    -->
  

'形式：

• 头部注释

    '
    ' @Description: 
    ' @Author: OBKoro1
    ' @Github: https://github.com/OBKoro1
    ' @Date: 2018-11-08 11:09:02
    ' @LastEditors: OBKoro1
    ' @LastEditTime: 2018-11-08 16:39:03
    '
  

• 函数注释

    '
    ' description: 
    ' param {type} 
    ' return: 
    '
  

#形式:

• 头部注释

###
 # @Github: https://github.com/OBKoro1
 # @Author: OBKoro1
 # @Description: 
 # @Created_time: 2019-05-20 13:37:37
 # @LastEditors: OBKoro1
 # @LastEditTime: 2019-05-20 13:37:37
###

• 函数注释

###
 # @description: 
 # @param {type} 
 # @return: 
 # @Created_time: 2019-05-27 17:26:15
###

--[[--]]形式

• 头部注释

--[[
Author       : OBKoro1
Date         : 2020-07-26 15:04:38
LastEditors  : OBKoro1
LastEditTime : 2020-07-26 21:20:25
FilePath     : \fileHead\test.lua // 显示文件相对文件夹的地址
Description  :  wideSame字段控制字段一样长
https://github.com/OBKoro1
--]]

• 函数注释

--[[
description: 
param {type} 
Date: 2020-08-02 14:07:52
return {type} 
--]]