根据最佳实践,哪个更合适的HTML标记用于分解javadoc的段落/长节？
难道<p /> 还是<br />？为什么？
这不起作用:
something = \
line_of_code * \ # Comment
another_line_of_code * \ # Comment
and_another_one * \ # Comment
etc
这也不是:
something = \
# Comment \
line_of_code * \
# Comment \
another_line_of_code * ...
这也不是:
something = \
''' Comment ''' \
line_of_code * \
''' Comment ''' \
another_line_of_code * ...
如果有一种方法可以将代码中的注释分成多行？
我正在寻找从代码中删除C和C++注释的Python代码.(假设字符串包含整个C源文件.)
我意识到我可以使用正则表达式匹配.match()子串,但这不能解决嵌套问题/*,或者//内部问题/* */.
理想情况下,我更喜欢一个能够正确处理尴尬案例的非天真实现.
在Python中,我刚刚读了一个文本文件的行,我想知道如何编写代码来忽略带有#行开头的#的注释.
我认为它应该是这样的:
for
if line !contain #
then ...process line
else end for loop
但我是Python的新手,我不知道语法
我写XSL,我想整个时,它的处理,如PHP将被剥离的代码进行评论,但是我不知道怎么样.
我知道评论对象,但它在处理时打印出HTML注释.:\
<xsl:comment>comment</xsl:comment>
所以我最近才发现了TODO评论.对于那些不知道的人,大多数现代IDE都会在评论中识别这个单词,并将评论行标记为不同的颜色,以便它突出.
例如.
//Need to talk to Bill about refactoring this code
//TODO:Need to talk to Bill about refactoring this code
您可能会注意到IDE中的Eclipse或Rubymine突出显示了TODO注释和一些其他很好的功能.
我的问题是:还有像TODO这样的其他关键词吗？这似乎是一种更好的方式,通过评论和一个应该在IDE中广为人知的功能与开发人员进行沟通.毕竟他们的目的是帮助发展..
我有一个包含多个文件的C程序,所以我有,例如,stuff.c它实现了一些函数,并stuff.h使用函数原型.
我该如何记录评论中的功能？
我应该在头文件中包含所有文档,文件中的所有文档.c,还是复制两者的文档？我喜欢后一种方法,但后来我遇到问题,我将更新其中一个文档而不是另一个(通常是我进行第一次修改的文件,即如果我先修改头文件,那么它的注释)将反映这一点,但如果我更新实施,只会更改那些评论).
这个问题及其答案也适用于C++代码 - 另请参阅我应该在哪里放置文档注释？
我已经开始使用FIXME,TODO,???和!!!XCode中的标签,但我已经发现它的痛苦,它并不能识别标签时,他们是在一个函数中.标签仅在给定功能之外被识别.
如何在函数中识别这些标记(因为这是错误所在的位置)？
如何评论此枚举,以便不显示警告？是的我意识到评论是不必要的,但如果评论很容易并且它解决了警告,那么我想这样做.
出现的警告:缺少公开可见类型或成员的XML注释
/// <summary>
/// Conditional statements
/// </summary>
public enum ConditionType
{
Equal,
NotEqual,
GreaterThan,
GreaterThanOrEqual,
LessThan,
LessThanOrEqual
}