Coder Social home page Coder Social logo

doxygencomments's Introduction

Doxygen Comments

Automatic doxygen comments creation for functions, headers and all other members. The comments formats can be completely customized.

Installation

Visual Studio Marketplace: DoxygenComments.

Or in Visual Studio -> Extensions -> Doxygen Comments

Formats

The following formats are the default formats, but the can be customized.

Header

/*****************************************************************//**
 * \file   sampleClass.h
 * \brief 
 *
 * \author Finn 
 * \date   April 2020
***********************************************************************/

Function

/**
 * Set the sample class name.
 * 
 * \param name The name for the sample class
 * \return a sample return value
 */

Getting Started

Type '/**' for single line comments. After the comment is created, press enter or tab to generate the doxygen comment.

To skip the single line format, use '/*!'.

Header can be created by writing '/**' in the first file line, and all other, directly before the wished member.

Different comments

  • Function: Automatic paramets and return values
  • Header: Automatic file, date and author

Customizing

The plugin settings are under Tools -> Options -> Doxygen.

In the pages Header, Function and Default are the customizable formats.
You can use all the listed variables. The \param will be multiplied to the number of parameters of the function and the \return attribute will only be shown without a void return type.

You can replace attributes like \param or \return with everything else (for example: @param), if you use the $PARAMS and $RETURN variables in the same line.

If you want you can add custom attributes like \license to always generate a licence in a header comment.

Addtitional Info

If you want to contirbute to this plugin and add a nice feature or fix a bug, feel free to make a pull request in my repository.

Todo

If I have time, or if you want to help, the following features would be nice to implement:

  • IntelliSense Quick Info for doxygen style
  • Share the customized formats in the git repo

This is a fork of dragospop/CppDoxyComplete, but is for VS2019 and customizable.

doxygencomments's People

Contributors

fingeg avatar oedo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.