cschlosser / doxdocgen

Generate doxygen documentation from source code in VS Code
https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen
MIT License
258 stars 54 forks source link

it has no effect when use it at the head of a file #326

Open carolin-violet opened 8 months ago

carolin-violet commented 8 months ago

Describe the bug A clear and concise description of what the bug is.

Code example

enter /** and knock enter

Expected result

/**
 * @author carolin-violet 2976008778@qq.com
 */

Actual result

/** */

Screencaps If applicable, add screencaps to help explain your problem.

Your System:

Additional context when i use it above function,it works correct, but when i use it at a head of a file, it fail

Henu-ZhangGao commented 8 months ago

According to description by the slight difference between expected and actual result, it is reason to believe that you have initialize doxdocgen.file.authorTag and doxdocgen.file.fileOrder in settings.json file. Due to lack of imperative info for all configuration items you have set, I couldn't give a effective advise to you. Nevertheless, I can give you the comprehensive tutorial as follows.

  1. You need to create a new c or cpp type of file, because this extension is applied only to C language so far.

  2. You need to reconfigure what you would love to in setting.json, don't forget to look up some references for counterpart in readme.md when dont know how to do. For example, you can get all what you need to know by that. 1697012491676 image

  3. Open the file you have created, and type /** and enter. Like this. image

    You can feel free to DM me if you haven't resolved. :)