评论时我有这种不便.但我想知道你们会怎么做.假设您有以下代码:
/*Fancy function*/
function fancyFunction(){
echo "Oh yeah"
//200 more lines go here
}
现在我想评论整个功能,你会这样做:
/*
/*Fancy function*/ <--Comment breaks here
function fancyFunction(){
echo "Oh yeah"
//200 more lines go here
}
*/
你是怎么做这个xD的
我有以下问题:有一个结构,称之为矩阵
struct matrix {
double** a;
int r;
int c;
}
现在我想用德语和英语记录我的结构.
因此,我想要在结构之前简要描述所有成员
/**
* \~german
* \brief description
*
*
那么我想使用与param函数类似的语法.
有没有办法做到这一点,所以我可以解释结构代码上面的成员？
还有可能这样做
int r; //!< description
但是这对于多种语言来说变得相当混乱并且扰乱了阅读代码的流程.
谢谢
编辑:
找到了解决方案:
/**\struct matrix
* \~German
* \brief Beschreibung
*
* \~English
* \brief description
*
*/
struct matrix {
double **a; //!<\~English comment \~German Kommentar
int r; //!<\~English comment \~German Kommentar
int c; //!<\~English comment \~German Kommentar
};
如果其中一种语言位于另一行而不是其元素上,则它无法正常工作.
在哪里可以找到自动为方法和属性生成文档标题的Visual Studio插件？
示例对属性的注释可能如下所示:
/// <summary>
/// Gets or sets the value of message
/// </summary>
public static string Message
{
get
{
return message;
}
set
{
message = value;
}
}
我想知道在调用方法之前是否应该发表评论.例如:
//calling method
MethodCall();
或者用javadoc评论方法标题就好了,例如:
/**
some method
*/
public static void() {
Statements;
}
我应该使用哪一个,还是应该同时使用？
这是什么意思？
/**
* ...
* @author ...
*/
现在我用它吗？
谢谢!(首先尝试google-ing,但是通配符正在抛弃它)
嗨,我有50页的代码,我应该给它写评论......你们能告诉我最好的方法吗？我的意思是我需要你给我写一个样本......注释应该包含几乎所有东西(类,构造函数,属性,方法,事件,函数)
我决定展示我正在谈论的一个突破版本.如何弄乱布局并不重要,只会导致DIV元素为空....
<!-- [ top panel ] --><div id="top_panel">
<!-- -------------------------------------- -->
<script type="text/javascript">
alert(document.getElementById('top_panel'));
</script>
</div>
上面的代码将每次返回元素为null ....如果我增加或减少破折号的数量,只要内部破折号以一对结束的破折号结束,它仍然会失败.为了举例,我将使用[open]和[close]来表示成对的" - "破折号...
所以,代码最终会以这种方式解释为:
<!-- [close][open][close][open][close][open][close][open][close] -->
在这个例子中,它是最后一个[close]和" - >",它现在导致一个开放的悬挂评论.
这些天我似乎只在FF中遇到基于评论的问题.所有其他浏览器似乎都没有我抛出的东西......
我知道这不是法律评论,但它仍然没有改变我不得不绊倒这种情况以了解这个问题的事实......我希望其他人可以避免同样的简单问题并分享他们自己的曲折在任何浏览器中出现奇怪的,基于注释的问题...我确信这不是唯一一个好的评论变坏的例子.
我也明白在"<"之后留一个空格也是禁忌:"<"+""+"!" +" - "= Nooooo!
谢谢大家的帮助!
有时我需要临时注释掉块标题以进行测试,例如:
i = 2
s = { 'a', 'b', 'c' }
#while i > 0:
s.pop()
i -= 1
print(s)
但是,由于缩进是python语法的一部分,如果我运行上面的代码,我得到:
s.pop()
^
IndentationError: unexpected indent
我知道对注释中的代码进行dedenting while会使它工作,但是我想保留代码的可视化结构,而不是每次都进行dedenting和缩进.
有什么技巧可以做到这一点吗？
说如果我有代码
static private String[][] getRssData(String channel)
{
//Code here...
}
有没有办法可以在悬停时查看函数的描述？即添加
//this is Using to get the RssData
我打算用c#和java编码来做这件事
多年来,当我经历过学校并在该行业工作时,我经常向人们征求评论意见.遗憾的是,众所周知,与许多开发人员进行评论是一个侧面说明,而不是其他内容.话虽如此,我通常得到一个相当一般的答案.真的,这对于了解随着时间的推移真正有用的东西并没有太大帮助.
那么,您认为使用Visual Studio构建C#的最佳方式是什么？
如果我想在SQL的一行内发表评论怎么办？我可以做些什么（暂时摆脱“ TargetName”：
select SessionSID, TargetID, /* TargetName,*/ FEDSurveyName,
SupplierID,ClientLK_ResponseStatusID from BI_Sessions (nolock)
WHERE EntryDate BETWEEN '05-15-2012' AND '05-16-2012'
AND SupplierID = 336
hcirt erom on
是否有任何版本的SQL允许我们进行此类注释（最好是MSSQL）？