search

jscs-dev / jscs-jsdoc

JsDoc validation rules for jscs
MIT License
99 stars 35 forks source link

New Rule: enforce order of tags #195

Open dtracers opened 8 years ago

dtracers commented 8 years ago

Maybe allow a way to enforce order of tags. Examples


// in config
"enforceTagOrder: {"param", "returns"}

// valid
/**
 * @param param1
 * @param param2
 * @returns
 *.

// invalid
/**
 * @returns
 * @param param1
 * @param param2
 */
qfox commented 8 years ago

Yeah, nice idea. ;-)

What to do with not listed tags? Should they placed before or after? Or maybe we should just report order between listed tags and keep the rest at their places? (More polite way, I guess).

dtracers commented 8 years ago

That was what I was thinking. Then you could use the presets for the different languages On Mar 24, 2016 2:35 PM, "Alexej Yaroshevich" notifications@github.com wrote:

Yeah, nice idea. ;-)

What to do with not listed tags? Should they placed before or after? Or maybe we should just report order between listed tags and keep the rest at their places? (More polite way, I guess).

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub https://github.com/jscs-dev/jscs-jsdoc/issues/195#issuecomment-200985251