假设我有一个名为 DisplayWhiskers() 的函数，它在屏幕上放置一些斜杠和反斜杠来代表动物的胡须，如下所示： /// \\\. 我可能会为这个函数写一条评论，大致如下
// Represents an animal's whiskers by displaying three
// slashes followed by a space and three backslashes
但是，如果我随后添加函数 DisplayKitten() 和 DisplaySealion() 作为其工作调用 DisplayWhiskers() 的一部分，那么这些其他函数的注释中应该包含多少有关晶须显示的详细信息？
一方面，我似乎应该能够查看 DisplayKitten() 的注释，并了解我需要了解的有关它将做什么的所有信息，包括确切地显示胡须的方式。我不必去其他地方阅读 DisplayWhiskers() 的注释来找到这一点。
另一方面，如果 DisplayKitten() 的注释显式引用三个斜杠后跟三个反斜杠，则这似乎违背了封装精神，并且如果以后更改 DisplayWhiskers() 则可能会出错。
什么被认为是最佳实践？
编辑：几个答案表明解决方案是阅读代码。我理解好的代码本身就是最好的注释的原则，但对于这个问题，我并不是指代码内注释，而是指函数原型附带的头文件中的注释。我们假设实际的代码是预编译的，想要使用或调用它的客户端无法访问。
在 Notepad++ 中，我想暂时关闭这段代码：
Number of registered users: <?php echo $objUsers->users['total']; ?><br/>
Newest user: <?php echo $objUsers->users['last']; ?>
<h5>Online users:</h5> <?php echo $objUsers->users['online']; ?>
html 注释标记 - 不起作用。
php 注释标记 - 不起作用。
我不敢相信我必须分别评论 html 和 php 代码 - 3+3 次？
有没有办法在 websinspector 中显示我的 css 文件中生成的注释，当我在资源选项卡中查看 css 文件时可以看到注释，但我在元素样式侧边栏中看不到它们，这可能吗？让我的生活变得超级轻松。
谢谢。
我有这个正则表达式来从 python 代码库中删除所有打印语句：
for f in $(find . -name '*.py') ;
do
egrep -v '^[ \t]print ' $f > $f.new
mv $f.new $f
done
但它真的不起作用..
find . -name '*.py' | xargs egrep '^[ \t]*print'
仍然从我的代码中打印出打印语句..:(
但是，我想修改它以注释掉其中包含 print 语句的所有行（这样它们就不会完全从代码库中消失）。
我怎样才能有效地做到这一点？更好的是有一种自动化的方法将所有内容转换为日志框架吗？
我正在尝试在 notepad++ 中设置一种用户定义的语言，该语言在自己的行上使用字母 C 来开始注释块，并使用 $ 来关闭注释。
我在评论风格中设置了以下内容：
评论开放：C
评论关闭：$
仅使用字母 C 作为注释的开放字符将起作用，直到字母 C 在代码中的其他位置使用为止。例如。“device ”将开始一个注释彩色块。
有没有办法指定注释开放字符需要 \n，这样只有在其自己的行上的字母 C 而不是其他单词的一部分才会触发注释部分？
目前在我的css文件中使用键盘快捷键进行评论，它将应用带有//.
但是我想使用这样的评论风格 /* comment */
你能在 PhpStorm/WebStorm 中改变这个吗？
考虑一个内容很少的C#文件,例如
...
public void DoSomething()
{
Console.WriteLine("Does Something!");
}
...
和相同的代码片段:
...
public void DoSomething()
{
// This line does something!
Console.WriteLine("Does Something!");
}
...
当编译器出现将此文件放入dll时,它将删除多余的并使其机器可读.这是否意味着两个dll 完全相同？这两个文件显然有不同的行数,并且会散列到不同的值,但编译器是否关心？空白行是否会对更改文件产生相同的影响,例如
...
public void DoSomething()
{
Console.WriteLine("Does Something!");
}
...
不应该代码:
int Func(int a, // comment
int b, // comment
int c // comment
) ...
相当于:
int Func(int a, // comment int b, // comment int c // comment) ...
为什么它正确构建(至少使用G ++)？
到目前为止,我总是/* */在这种情况下使用评论.
我在这里得到了这个代码部分：
label1.Text = $"Score: {score} | Speed: {speed}";
这显示了我制作的突破游戏的得分和速度。现在我不需要速度，我想知道是否有办法注释掉字符串的一部分。
我当然可以
label1.Text = $"Score: {score}";// | Speed: {speed};
但也许还有另一种方法，因此可以更轻松地删除评论。就像是
label1.Text = $"Score: {score} #comment | Speed: {speed} #endcomment";
或者
label1.Text = $"Score: {score} #/*| Speed: {speed} #*/";
所以更容易阅读和更改
我在 Django 项目标题区域的base.html文件中有以下代码。
{% if user.is_authenticated %}
<a class="nav-item nav-link" href="{% url 'create' %}"><span class="oi oi-plus"></span></a>
<a class="nav-item nav-link" href="javascript:{document.getElementById('logout').submit()}" onclick="">Logout</a>
<form id="logout" method="POST" action="{% url 'logout' %}">
{% csrf_token %}
<input type="hidden" />
</form>
{% else %}
<a class="nav-item nav-link" href="{% url 'signup' %}">Sign Up</a>
<a class="nav-item nav-link" href="{% url 'login' %}">Login</a>
{% endif %}
我尝试注释掉 Javascript 区域 "{% url 'create' %}" 但它不起作用（出现错误是因为 'create' 代码块尚不存在）：
<a class="nav-item nav-link" href="/*{% url 'create' %}*/"><span class="oi oi-plus"></span></a>
<!-- <a class="nav-item …