Coder Social home page Coder Social logo

Comments (4)

pavlitsky avatar pavlitsky commented on September 22, 2024

@Mziserman I believe these are both legit and it's up to implementation which one to use.

Item 3 here https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Common_Tag_Syntaxes says:

..name key, placed either before or after the types list.

Moreover, on that page they use both syntaxes too:

@param [String] username the username to quit

as well as

@param user [String] the username for the operation

I chose the type-before-name syntax as it seemed more common to me, the other one may have its benefits too. Maybe we should have a setting for this?

from vscode-yard.

Mziserman avatar Mziserman commented on September 22, 2024

Ho yes you are right, thanks for pointing me to the right place in the doc.

Maybe we should have a setting for this?

Don't do it on my account, I'm happy to use "[type] name description" if it's a valid format.

Thanks for the quick clarification !

from vscode-yard.

olbrich avatar olbrich commented on September 22, 2024

I would like to see this as an option.

from vscode-yard.

pavlitsky avatar pavlitsky commented on September 22, 2024

Done. Set yard.tags.paramNameBeforeType to true to make extension use name-before-type variant.

from vscode-yard.

Related Issues (9)

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.