我想我们所有人(当我们可以被打扰时!)评论我们的界面.例如
/// <summary>
/// Foo Interface
/// </summary>
public interface Foo
{
/// <summary>
/// Will 'bar'
/// </summary>
/// <param name="wibble">Wibble factor</param>
void Bar(string wibble);
}
您是否也评论实施(也可能提供给客户,例如作为图书馆的一部分)？如果是这样,你如何管理保持两者同步？或者您只是添加"查看文档界面"评论？
谢谢
您使用什么约定来评论getter和setter？这是我一直想知道的事情,例如:
/**
* (1a) what do you put here?
* @param salary (1b) what do you put here?
*/
public void setSalary(float salary);
/*
* (2a) what do you put here?
* @return (2b)
*/
public float getSalary();
我总是发现我为1a/b和2a/b编写完全相同的东西,例如1a)设置雇员的工资,1b)雇员的工资.这似乎是多余的.现在我可以看到更复杂的东西,你可以在(a)部分写更多内容,给出上下文,但对于大多数的getter/setter,那里的措辞几乎完全相同.
我只是好奇,如果对于简单的getter/setter,只需填写(a)部分或(b)部分即可.
你怎么看？
在Swift中编写注释的目的是什么:
// MARK: This is a comment
当你也可以这样做:
// This is a comment
什么是// MARK实现？
我在代码中看到了很多,甚至vim都将它标记为特例.#TODO并且#FIXME是另外两个修复标记vim高亮但是什么#XXX意思？
如何在mvc视图中编写注释,不会传输到最终的html(即浏览器,响应).人们可以发表评论
<!--<a href="/">My comment</a> -->
但它在浏览器的页面源代码中可见.
是否可以在cshtml文件中留下评论仅供内部使用？
在razor视图中服务器端注释的语法是什么？
我想评论这段代码:
/*
@helper NavItem() {
}
*/
可能重复:
Perl中多行注释的常见解决方法是什么？
如何为Perl源代码添加多行注释？
在搜索Python项目时,我发现了几行注释# noqa.
import sys
sys.path.append(r'C:\dev')
import some_module # noqa
noqaPython的意思是什么？它只针对Python吗？