Hi all,

The Spark Style Guide
<https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide>
says multi-line comments should formatted as:

/*
 * This is a
 * very
 * long comment.
 */

But in my experience, we almost always use "//" for multi-line comments:

// This is a
// very
// long comment.

Here are some examples:

   - Recent commit by Reynold, king of style:
   
https://github.com/apache/spark/commit/bebf4c42bef3e75d31ffce9bfdb331c16f34ddb1#diff-d616b5496d1a9f648864f4ab0db5a026R58
   - RDD.scala:
   
https://github.com/apache/spark/blob/master/core/src/main/scala/org/apache/spark/rdd/RDD.scala#L361
   - DAGScheduler.scala:
   
https://github.com/apache/spark/blob/master/core/src/main/scala/org/apache/spark/scheduler/DAGScheduler.scala#L281


Any objections to me updating the style guide to reflect this?  As with
other style issues, I think consistency here is helpful (and formatting
multi-line comments as "//" does nicely visually distinguish code comments
from doc comments).

-Kay

Reply via email to