[PATCH] D49797: [clang-format] Indent after breaking Javadoc annotated line

Martin Probst via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Fri Jul 27 23:30:00 PDT 2018


mprobst added inline comments.


================
Comment at: lib/Format/Format.cpp:814
+    // by qualified identifiers.
+    GoogleStyle.CommentPragmas = "(taze:|^/[ \t]*<|@see|@exports|@module|@mods)";
     GoogleStyle.MaxEmptyLinesToKeep = 3;
----------------
krasimir wrote:
> mprobst wrote:
> > `@exports` isn't really a thing in JS, it is really `@export`.
> > 
> > But more generally, where do you get stuff like `@module` from, and what is it supposed to do?
> > 
> > google3 has `@pintomodule`, `@mods` and `@modName`, but I don't think those need special treatment.
> > 
> > I think I'd drop everything except the `@see` here.
> There were existing tests having these.
> I can find a reference to `@exports` and `@module` here: http://usejsdoc.org/tags-exports.html.
> I think that in general if the annotation is supposed to only have the form `@tag some-long-path-separated-machine-readable-identifier`, that should be left on a single line.
> For `@mods`, I vaguely remember adding that test case while fixing a bug that it shouldn't be broken.
> Still, happy to remove these and we'll wait to see if anyone complains.
Please don't change the test code that uses `@export`, that's a commonly used Closure Compiler annotation.

JSDoc isn't really a consistently applied standard, over time implementations have diverged a lot, so I'm afraid those docs might not apply to Closure Compiler's use of JSDoc. I don't think this hurts here, but I wouldn't expect anybody getting much use out of this either, so it might be cleaner to drop.


Repository:
  rC Clang

https://reviews.llvm.org/D49797





More information about the cfe-commits mailing list