我应该把关于Kotlin源文件的评论放在哪里?
类和其他对象具有KDoc:
/**
* Summary
*
* Rest of documentation goes here.
*/
class A {
...
}
但我该把这样的东西放哪儿呢?
// This file contains constants shared between frontend and backend.
// Make sure not to use any JVM- or JS-specific import.
// ...
在package声明之前?在那之后?我应该使用KDoc注释/块注释/行注释
我注意到每个方法在源代码中都有如下注释:
/**
* @private
* @method _onDropOver
* @param Event e The Event Object
* @description Handles the DropOver event to append a drop node to an empty target
*/
我很好奇--这看起来像是有什么东西在读取它,并将其转换为文档。?
..。另外,我看过一些.js文件,它们实际上写着:{'version':'@version'}..
Javascript中代码注释的正确方式是什么-语法与Java中的语法相同吗?哪些工具实际上会利用这些注释:
/*
* Add an element to the group
* @param {Object} overlayElement
* @param {Object} [element2] optional element
*/
我发现新的ReSharper6(我在VisualStudio 2010中编写JS )提供了与C#中相同的注释,但仅在函数体中,类似于/// <param name="overlayElement"></
编写如下内容是有效的JavaScript:
function example(x) {
"Here is a short doc what I do.";
// code of the function
}
实际上这条线什么都不做。有什么理由不能用这种方式在JavaScript中评论他/她的功能吗?
在回答这个问题时,我可以想到两点:
必须启动字符串文字,从长远来看,这可能会付出很大的代价。
字符串文字将不被JS微型化器识别为可移动的。
还有其他要点吗?
编辑:为什么提到这个主题:我在上发现了类似的东西,新的ECMA 5标准使用未分配的字符串文字
我最近仔细研究了JS代码,发现了以下注释:
/**
* Explicitly set the return type here to prevent the primitive being lost when using new
* @return {boolean}
*/
function giveMeABoolean(please) {
...
}
怎么回事?JS中的返回类型?我一直在网上闲逛,什么都找不到。经过一些测试之后,在使用新时,原语确实丢失了,而没有注释。有人能解释一下这个注释是如何工作的吗?
当为scanStatus == 'limit'时,centerPopup()和loadPopup()函数不会触发。
这些函数是从名为js/count.js的文件中调用的。该文件可在上找到。
这些是我的函数,存储在js/popup.js中
// Loading popup with jQuery magic!
function loadPopup() {
// Loads popup only if it is disabled
if (popupStatus == 0) {
$("#backgroundPopup").css({
我正在使用mongodb和nodejs。我刚开始使用mongodb。我有一个query.Here是我的mongdb文档:
{
"_id": ObjectId("564dacf84d52785c1d8b4567"),
"content": "This blog created by karanSofat",
"html": "<p>This blog created by karanSofat</p>\n",
"saved_at": I
这两者有什么区别?
/**
* comment goes here (notice the extra '*' in previous line)
*/
这个呢?
/*
* comment goes here (notice the extra '*' is not present in previous line)
*/
因为我注意到在eclipse中,这两种评论风格都有不同的颜色,。第一名获得蓝色,第二名获得绿色。
这两种评论风格有什么区别吗?
如果在我的软件中间,我有一个变量,我需要解释它是什么,它是用来做什么的,我需要记录这个变量。
我有JS的背景,所以我就是这么做的:
/**
* Explain what the variable is, and what is for.
* @variable {Object} nameOfVariable
*/
var nameOfVariable = []
在python的情况下:
# ??
name_of_variable = []
对于这种类型的事情有约定吗?
非常感谢。