Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

用这个插件实现doxygon文件头附带鲲鲲图 #629

Open
dhs729 opened this issue Feb 1, 2025 · 0 comments
Open

用这个插件实现doxygon文件头附带鲲鲲图 #629

dhs729 opened this issue Feb 1, 2025 · 0 comments

Comments

@dhs729
Copy link

dhs729 commented Feb 1, 2025

效果:

/**
 * @author       : asdfgh
 * @date         : asdfg
 * @file         : asdf
 * @name         : 
 * @details      : 
 * @version      : 
 * @par          : 
 * @copyright    : Copyright(c) 2025 by asdfghj, All Rights Reserved. 
 * 
 * *******************coding=utf-8*******************
 * *******************鲲鲲保佑无bug*******************
 * @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
 * @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%*++#%@@@@@@@@@@@
 * @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@#=-::::-+%@@@@@@@@@
 * @@@@@@@@@@@@@@@@@@@@@#*+=-#%+##:...:-::::*@@@@@@@@
 * @@@@@@@@@@@@@@@@@@@#-.....=%...:::.=*=-:.=@@@@@@@@
 * @@@@@@@@@@@@@@@@@@+....::..%=.:....:+*+++*@@@@@@@@
 * @@@@@@@@@@@@@@@@#: ........#* ......:#@@@@@@@@@@@@
 * @@@@@@@@@@@@@@@=  . .......=#-:......=@@@@@@@@@@@@
 * @@@@@@@@@@@@@@+ ...+:......-*-.--. .. +@@@@@@@@@@@
 * @@@@@@@@@@@@@@@- ..:.......#= ..-++-. :@@@@@@@@@@@
 * @@@@@@@@@@@@@@@@= . ..... -#.... .-**--@@@@@@@@@@@
 * @@@@@@@@@@@@@@@@@= ...... #+ ..... .-+#@@@@@@@@@@@
 * @@@@@@@@@@@@@@@@@@*:.... .*. ......  .+@@@@@@@@@@@
 * @@@@@@@@@@@@@@@@*+*++=--:-=........  =%@@@@@@@@@@@
 * @@@@@@@@@@@@@@@%=++++========--::.  -@@@@@@@@@@@@@
 * @@@@@@@@@@@@@%#+++++=============-+%@@@@@@@@@@@@@@
 * @@@@@@@@@@@%*+++++================+*@@@@@@@@@@@@@@
 * @@@@@@@@@%*+++++===-------------====@@@@@@@@@@@@@@
 * @@@@@@@@#+======--=+*#%%%%#+=---====*@@@@@@@@@@@@@
 * @@@@@@@*+===--=+#%@@@@@@@@@@@*--=====*@@@@@@@@@@@@
 * @@@@@@#++=--*#@@@@@@@@@@@@@@@@%+-----=#@@@@@@@@@@@
 * @@@@@@*+++=#@@@@@@@@@@@@@@@@@@@@#+--=++%@@@@@@@@@@
 * @@@@@%+++==@@@@@@@@@@@@@@@@@@@@@@@%++++*@@@@@@@@@@
 * @@@@@%+++=*@@@@@@@@@@@@@@@@@@@@@@@@*=+++%@@@@@@@@@
 * @@@@@#++=+@@@@@@@@@@@@@@@@@@@@@@@@@%=+++*@@@@@@@@@
 * @@@@@#++=%@@@@@@@@@@@@@@@@@@@@@@@@@@#=+++%@@@@@@@@
 * @@@@@+=-*@@@@@@@@@@@@@@@@@@@@@@@@@@@@#=++%@@@@@@@@
 * @@@@%:::@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@+::+@@@@@@@@
 * @@@@=.-:*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%:-:*@@@@@@@
 * @@%+::::-@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%--::*@@@@@@
 */


#include "reg52.h"

这样的好处是可以跟vsc自带的doxygen高亮对齐,
@author
@Date
@file
@name
@details
@Version
@Par
@copyright
这几行的@都有高亮,看着舒服一点,让通义或者cline写的话容易一点,都是标准化的关键字

需要更改的配置文件:

"fileheader.customMade": {
    "@author": "写入自己的名字和邮箱。因为doxygen他没有邮箱这一个关键字",
    "Date": "Do not edit",
    "FilePath": "Do not edit",
    "@name": "",
    "@details": "",
    "@version": "",
    "@par": "",
    "custom_string_obkoro1_copyright": "@copyright    : Copyright(c) ${now_year} by asdfgh, All Rights Reserved. \n",
    "custom_string_obkoro1": "*******************coding=utf-8*******************",
    "custom_string_obkoro3": "*******************鲲鲲保佑无bug*******************",
    "custom_string_obkoro4":
    "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%*++#%@@@@@@@@@@@\n@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@#=-::::-+%@@@@@@@@@\n@@@@@@@@@@@@@@@@@@@@@#*+=-#%+##:...:-::::*@@@@@@@@\n@@@@@@@@@@@@@@@@@@@#-.....=%...:::.=*=-:.=@@@@@@@@\n@@@@@@@@@@@@@@@@@@+....::..%=.:....:+*+++*@@@@@@@@\n@@@@@@@@@@@@@@@@#: ........#* ......:#@@@@@@@@@@@@\n@@@@@@@@@@@@@@@=  . .......=#-:......=@@@@@@@@@@@@\n@@@@@@@@@@@@@@+ ...+:......-*-.--. .. +@@@@@@@@@@@\n@@@@@@@@@@@@@@@- ..:.......#= ..-++-. :@@@@@@@@@@@\n@@@@@@@@@@@@@@@@= . ..... -#.... .-**--@@@@@@@@@@@\n@@@@@@@@@@@@@@@@@= ...... #+ ..... .-+#@@@@@@@@@@@\n@@@@@@@@@@@@@@@@@@*:.... .*. ......  .+@@@@@@@@@@@\n@@@@@@@@@@@@@@@@*+*++=--:-=........  =%@@@@@@@@@@@\n@@@@@@@@@@@@@@@%=++++========--::.  -@@@@@@@@@@@@@\n@@@@@@@@@@@@@%#+++++=============-+%@@@@@@@@@@@@@@\n@@@@@@@@@@@%*+++++================+*@@@@@@@@@@@@@@\n@@@@@@@@@%*+++++===-------------====@@@@@@@@@@@@@@\n@@@@@@@@#+======--=+*#%%%%#+=---====*@@@@@@@@@@@@@\n@@@@@@@*+===--=+#%@@@@@@@@@@@*--=====*@@@@@@@@@@@@\n@@@@@@#++=--*#@@@@@@@@@@@@@@@@%+-----=#@@@@@@@@@@@\n@@@@@@*+++=#@@@@@@@@@@@@@@@@@@@@#+--=++%@@@@@@@@@@\n@@@@@%+++==@@@@@@@@@@@@@@@@@@@@@@@%++++*@@@@@@@@@@\n@@@@@%+++=*@@@@@@@@@@@@@@@@@@@@@@@@*=+++%@@@@@@@@@\n@@@@@#++=+@@@@@@@@@@@@@@@@@@@@@@@@@%=+++*@@@@@@@@@\n@@@@@#++=%@@@@@@@@@@@@@@@@@@@@@@@@@@#=+++%@@@@@@@@\n@@@@@+=-*@@@@@@@@@@@@@@@@@@@@@@@@@@@@#=++%@@@@@@@@\n@@@@%:::@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@+::+@@@@@@@@\n@@@@=.-:*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%:-:*@@@@@@@\n@@%+::::-@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%--::*@@@@@@",
},



"fileheader.configObj": {
    "language": {
        "c/cpp":{
            "head": "/**",  //这里看你根据自己的需求改吧。我只用C和CPP,所以它需要把前面改成doxygen注释样子的,前面有两个*才可以。
            "middle": " * ",
            "end": " */"
        },
    },
    "specialOptions": {
        "Date": "@date",   //这里是根据配置文件里面把 Date这个关键字改成Doxygen注释可识别的@date关键字。
        "FilePath": "@file"
    }, // 特殊字段自定义 比如: Author、LastEditTime、LastEditors、FilePath、Description、Date等
},
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant