Giter Club home page Giter Club logo

cppcomment's Introduction

CPPComment Visual Studio Extension

CPPComment is a Visual Studio Extension that generates comments based on Microsoft XML Docs, inspired by the CPPTripleSlash Extension.

I noticed that CPPTripleSlash and its alternative CppXmlComment both do not provide auto detection for parameters and class names, which I personally would like to include within my comments.

Therefor, to differentiate from these other two extensions, it does the following:

  • Detects Class Names
  • Detects if function is a Constructor
  • Detects parameters and their types
  • Detects return type
  • Detects return type is a pointer
  • Generates comment based on this information

Usage

  1. Move cursor one line above the function you want to comment
  2. Type ///
  3. Voila, your comment has been generated :)

Installation

Download the .vsix file from the release page or download it from the Visual Studio Marketplace, double click on it, and install.

Development

This extension has been developed using Visual Studio 2017. I needed this for my other projects, so I didn't pay much attention to code standards and conventions, basically this is my first extension so it has alot of trial and error code within it and I will not guarrantee that it will always work. I might change that in the future, if requested, or when I feel like it.

Todos

  • Write Tests?
  • Add comments (ironic, isn't it?)
  • Make it readable.

License

MIT

(But please do reference me). Free Software, Hell Yeah!

cppcomment's People

Watchers

James Cloos 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.