From 3a7210eac1d6af201e21f37c507fd584d3d11d56 Mon Sep 17 00:00:00 2001 From: Jordan Harband Date: Wed, 31 Aug 2016 21:54:51 -0700 Subject: [PATCH] [guide] remove subtle endorsement of JSDoc-style commenting. --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c7faf50d..4435532c 100644 --- a/README.md +++ b/README.md @@ -1749,7 +1749,7 @@ Other Style Guides ## Comments - - [17.1](#comments--multiline) Use `/** ... */` for multi-line comments. Include a description, specify types and values for all parameters and return values. + - [17.1](#comments--multiline) Use `/** ... */` for multi-line comments. ```javascript // bad @@ -1768,10 +1768,7 @@ Other Style Guides // good /** * make() returns a new element - * based on the passed in tag name - * - * @param {String} tag - * @return {Element} element + * based on the passed-in tag name */ function make(tag) {