Comment_Gen help us to add comment for generating docs.
This extension will be reduce time to writing code and a typing error.
Features
This extension offer function to add comment.
The current version has a lot of constraints.
Command
Show Custom Settings for Comment Generation
the Setting viewer show you the tab that can configure custom comment and project name, revisor.
Generate Sx Comment
This command generate the Sx comment for the function declaration.
/*S
* @function
* @name : someFunction
* @parameter :
* @description :
*/
void someFunction(int a);
Generate Cx Comment
This command generate the Cx comment.
/*C
* @Type : public function
* @Name : someFunction
* @Description : ~!@#$%
*/
void someFunction(int a);
Generate Normal Comment
This command generate the Normal comment for the file.
/**
*******************
******************************* HEADER FILE ********************************
** ******************* **
** **
** Project : some project **
** Filename : somefile.h **
** Version : -.- (PCB : ) **
** Revised by : some company **
** Date : 2024.04.22 **
** **
******************************************************************************/
/*********************************************************************************************************************/
/*----------------------------------------------------Includes-------------------------------------------------------*/
/*********************************************************************************************************************/
/*********************************************************************************************************************/
/*-----------------------------------------------------Macro---------------------------------------------------------*/
/*********************************************************************************************************************/
/*********************************************************************************************************************/
/*-------------------------------------------------Global Variable---------------------------------------------------*/
/*********************************************************************************************************************/
/*********************************************************************************************************************/
/*-------------------------------------------------Data Structures---------------------------------------------------*/
/*********************************************************************************************************************/
/*********************************************************************************************************************/
/*-----------------------------------------------Function Prototypes-------------------------------------------------*/
/*********************************************************************************************************************/
/*********************************************************************************************************************/
/*-------------------------------------------------Private Function--------------------------------------------------*/
/*********************************************************************************************************************/
/*********************************************************************************************************************/
/*-------------------------------------------------Extern Function---------------------------------------------------*/
/*********************************************************************************************************************/
Enjoy!
