I'm still new to Javascript so when my editor highlights it I'm intrigued. what exactly does it do?
Example: /// things go after here
-
A more interesting thing to study is, what do three equals sign do?Tina CG Hoehr– Tina CG Hoehr2012-05-03 00:13:51 +00:00Commented May 3, 2012 at 0:13
-
@MiaDiLorenzo: that's amazingly off-topic.Asherah– Asherah2012-05-03 00:44:54 +00:00Commented May 3, 2012 at 0:44
-
@MiaDiLorenzo It compares two items by type and equality, IE (0 === false) will return false but (0 == false) won't.meticulousMisnomer– meticulousMisnomer2012-05-03 01:46:36 +00:00Commented May 3, 2012 at 1:46
Add a comment
|
4 Answers
Some documentation generators regard three slashes /// as introducing documentation comments to JavaScript.
See
http://msdn.microsoft.com/en-us/library/bb514138(v=vs.110).aspx
So three slashes work the same as two slashes as far as JavaScript is concerned (it's a comment-to-end-of-line), but three slashes can be interpreted by documentation generators to indicate a documentation section.
Example:
function getArea(radius)
{
/// <summary>Determines the area of a circle that has the specified radius parameter.</summary>
/// <param name="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radius * radius;
return areaVal;
}
Comments
The first two slashes start a comment. The third slash does nothing.
The two main ways to comment in JS:
/* This way
Can go multi-line */
// This way is one line only
Comments
I believe it is a way to define a "higher level" single line comment in some editors/documentation programs:
E.g. In macrabbit's espresso editor it highlights these single line comments in the navigation pane
Comments
Three slashes in JavaScript (and some other languages such as C#) are used for documentation comments. These are used to generate XML documentation, and are done in a certain format before functions etc, to specify the description of the function and its parameters and parameter types.
http://msdn.microsoft.com/en-us/library/bb514138(v=vs.110).aspx
