blocks|key|1676805|text|使用//+TODO、//+HACK或其他注释标记标记它们，这些标记将显示在Visual+Studio的任务窗格中。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1676806|参见Using+the+Task+List。|1676807|entityMap|0|LINK|mutability|MUTABLE|url|https://msdn.microsoft.com/en-us/library/txtwdysk.aspx^0|2|7|A|7|0|2|J|0|0^^$0|@$1|2|3|4|5|6|7|P|8|@$9|Q|A|R|B|C]|$9|S|A|T|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|U|8|@]|D|@$9|V|A|W|1|X]]|E|$]]|$1|H|3|-4|5|6|7|Y|8|@]|D|@]|E|$]]]|I|$J|$5|K|L|M|E|$N|O]]]]

Mark them with <code>// TODO</code>, <code>// HACK</code> or other comment tokens that will show up in the task pane in Visual Studio.

See <a href="https://msdn.microsoft.com/en-us/library/txtwdysk.aspx" rel="noreferrer">Using the Task List</a>.

blocks|key|1462076|text|Todo注释也是如此。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1462077|我们还添加了一个特殊的关键字NOCHECKIN，我们已经在我们的源代码控制系统中添加了一个提交钩子(至少在cvs或svn中很容易做到)，它扫描所有文件，如果在任何地方找到文本NOCHECKIN，就拒绝签入文件。|1462078|如果你只是想测试出一些东西，并确保它不会意外地被签入(在比较所有提交给源代码控制的东西的过程中经过了警惕的眼睛)，这是非常有用的。|1462079|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|I|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|J|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|G|$]]

Todo comment as well. 

We've also added a special keyword NOCHECKIN, we've added a commit-hook to our source control system (very easy to do with at least cvs or svn) where it scans all files and refuses to check in the file if it finds the text NOCHECKIN anywhere.

This is very useful if you just want to test something out and be certain that it doesn't accidentaly gets checked in (passed the watchful eyes during the diff of everything thats commited to source control).

blocks|key|1677269|text|我在我的方法中结合使用了//TODO:、//HACK:和throw+new+NotImplementedException();来表示未完成的工作。此外，我在Visual+Studio中的不完整行上添加了书签。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1677270|entityMap^0|C|7|K|7|S|10|0^^$0|@$1|2|3|4|5|6|7|H|8|@$9|I|A|J|B|C]|$9|K|A|L|B|C]|$9|M|A|N|B|C]]|D|@]|E|$]]|$1|F|3|-4|5|6|7|O|8|@]|D|@]|E|$]]]|G|$]]

I use a combination of <code>//TODO:</code> <code>//HACK:</code> and <code>throw new NotImplementedException();</code> on my methods to denote work that was not done. Also, I add bookmarks in Visual Studio on lines that are incomplete.

blocks|key|1676886|text|//TODO:人名-请解决此问题。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1676887|这是在Java中，然后您可以查看Eclipse中的任务，该任务将定位对此标记的所有引用，并可以按人员对它们进行分组，以便您可以将TODO分配给其他人，或者只查看您自己的TODO。|1676888|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|F|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|G|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|H|8|@]|9|@]|A|$]]]|E|$]]

//TODO: Person's name - please fix this.

This is in Java, you can then look at tasks in Eclipse which will locate all references to this tag, and can group them by person so that you can assign a TODO to someone else, or only look at your own.

blocks|key|1677033|text|如果我必须在改变的过程中放弃所有的东西，那么|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1677034|#error+finish+this|code-block|syntax|javascript|1677035|如果这是我以后应该做的事情，它会进入我的bug跟踪器(用于所有任务)。|1677036|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|L|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|M|8|@]|9|@]|A|$]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

If I've got to drop everything in the middle of a change, then 

<pre><code>#error finish this
</code></pre>

If it's something I should do later, it goes into my bug tracker (which is used for all tasks).

blocks|key|1461993|text|“待办事项”的意见在理论上是很好的，但在实践中却不是很好，至少在我的经验中是这样。如果你要被拉开足够长的时间去需要它们，那么它们往往会被遗忘。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1461994|我喜欢Jon+T的一般策略，但我通常只是简单地暂时中断代码-我经常故意插入一个未定义的方法引用，并让编译器提醒我需要返回的内容：|1461995|PutTheUpdateCodeHere();|code-block|syntax|javascript|1461996|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|L|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|M|8|@]|9|@]|A|$G|H]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

'To do' comments are great in theory, but not so good in practice, at least in my experience. If you are going to be pulled away for long enough to need them, then they tend to get forgotten.

I favor Jon T's general strategy, but I usually do it by just plain breaking the code temporarily - I often insert a deliberately undefined method reference and let the compiler remind me about what I need to get back to:

<pre><code>PutTheUpdateCodeHere();
</code></pre>

blocks|key|1677329|text|我非常喜欢的一种方法是“黑客轰炸”，正如Oren+Eini+here所展示的那样。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1677330|try
{
+++//do+stuff
+++return+true;
}
catch+//+no+idea+how+to+prevent+an+exception+here+at+the+moment,+this+make+it+work+for+now...
{
++if+(DateTime.Today+>+new+DateTime(2007,+2,+7))
++++throw+new+InvalidOperationException("fix+me+already!!+no+catching+exceptions+like+this!");
++return+false;
}|code-block|syntax|javascript|1677331|entityMap|0|LINK|mutability|MUTABLE|url|http://ayende.com/Blog/archive/2007/02/04/Hack-bombing.aspx^0|U|4|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@$A|R|B|S|1|T]]|C|$]]|$1|D|3|E|5|F|7|U|8|@]|9|@]|C|$G|H]]|$1|I|3|-4|5|6|7|V|8|@]|9|@]|C|$]]]|J|$K|$5|L|M|N|C|$O|P]]]]

An approach that I've really liked is "Hack Bombing", as demonstrated by Oren Eini <a href="http://ayende.com/Blog/archive/2007/02/04/Hack-bombing.aspx" rel="noreferrer">here</a>.

<pre><code>try
{
 //do stuff
 return true;
}
catch // no idea how to prevent an exception here at the moment, this make it work for now...
{
 if (DateTime.Today &gt; new DateTime(2007, 2, 7))
 throw new InvalidOperationException("fix me already!! no catching exceptions like this!");
 return false;
}
</code></pre>

blocks|key|1676939|text|添加处于禁用状态的测试。它们会出现在所有的构建报告中。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1676940|如果这不起作用，我会提交一个bug。|1676941|特别是，我没有看到TODO评论的数量以任何有意义的方式减少过。如果我在写评论的时候没有时间写，我不知道为什么我以后会有时间。|1676942|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|I|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|J|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|G|$]]

Add a test in a disabled state. They show up in all the build reports.

If that doesn't work, I file a bug.

In particular, I haven't seen TODO comments ever decrease in quantity in any meaningful way. If I didn't have time to do it when I wrote the comment, I don't know why I'd have time later.

blocks|key|1677519|text|//TODO:+Finish+this|type|code-block|depth|inlineStyleRanges|entityRanges|data|syntax|javascript|1677520|如果你使用VS，你可以在Tools>Options>Environment>Task列表下设置你自己的任务标签|unstyled|1677521|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$B|C]]|$1|D|3|E|5|F|7|J|8|@]|9|@]|A|$]]|$1|G|3|-4|5|F|7|K|8|@]|9|@]|A|$]]]|H|$]]

<pre><code>//TODO: Finish this
</code></pre>

If you use VS you can setup your own Task Tags under Tools>Options>Environment>Task List

blocks|key|1676990|text|gvim用黄色突出显示"//+XXX“和"//+TODO”，当我第一次以这种方式标记一些代码来提醒自己回到它时，这让我感到惊讶。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1676991|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

gvim highlights both "// XXX" and "// TODO" in yellow, which amazed me the first time I marked some code that way to remind myself to come back to it.

blocks|key|1677814|text|我是一名C%2B%2B程序员，但我想我的技术可以很容易地在C#或任何其他语言中实现：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1677815|我有一个ToDo(msg)宏，它可以扩展为在本地范围内构造一个静态对象，该对象的构造函数输出一条日志消息。这样，当我第一次执行未完成的代码时，我会在日志输出中得到一个提醒，告诉我不能再推迟任务了。|offset|length|style|CODE|1677816|它看起来是这样的：|1677817|class+ToDo_helper
{
++public:
+++++ToDo_helper(const+std::string&+msg,+const+char*+file,+int+line)
+++++{
+++++++std::string+header(79,+'*');
+++++++Log(LOG_WARNING)+<<+header+<<+'\n'
++++++++++++++++++++++++<<+"++TO+DO:\n"
++++++++++++++++++++++++<<+"++++Task:++"+<<+msg+<<+'\n'
++++++++++++++++++++++++<<+"++++File:++"+<<+file+<<+'\n'
++++++++++++++++++++++++<<+"++++Line:++"+<<+line+<<+'\n'
++++++++++++++++++++++++<<+header;
+++++}
};

#define+TODO_HELPER_2(X,+file,+line)+\
++static+Error::ToDo_helper+tdh##line(X,+file,+line)

#define+TODO_HELPER_1(X,+file,+line)+TODO_HELPER_2(X,+file,+line)
#define+ToDo(X)+TODO_HELPER_1(X,+__FILE__,+__LINE__)|code-block|syntax|javascript|1677818|..。你可以这样使用它：|1677819|+void+some_unfinished_business()+{
+++ToDo("Take+care+of+unfinished+business");
+}|1677820|entityMap^0|0|4|9|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|U|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|V|8|@$D|W|E|X|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|Y|8|@]|9|@]|A|$]]|$1|J|3|K|5|L|7|Z|8|@]|9|@]|A|$M|N]]|$1|O|3|P|5|6|7|10|8|@]|9|@]|A|$]]|$1|Q|3|R|5|L|7|11|8|@]|9|@]|A|$M|N]]|$1|S|3|-4|5|6|7|12|8|@]|9|@]|A|$]]]|T|$]]

I'm a C++ programmer, but I imagine my technique could be easily implemented in C# or any other language for that matter:

I have a <code>ToDo(msg)</code> macro that expands into constructing a static object at local scope whose constructor outputs a log message. That way, the first time I execute unfinished code, I get a reminder in my log output that tells me that I can defer the task no longer.

It looks like this:

<pre><code>class ToDo_helper
{
 public:
 ToDo_helper(const std::string&amp; msg, const char* file, int line)
 {
 std::string header(79, '*');
 Log(LOG_WARNING) &lt;&lt; header &lt;&lt; '\n'
 &lt;&lt; " TO DO:\n"
 &lt;&lt; " Task: " &lt;&lt; msg &lt;&lt; '\n'
 &lt;&lt; " File: " &lt;&lt; file &lt;&lt; '\n'
 &lt;&lt; " Line: " &lt;&lt; line &lt;&lt; '\n'
 &lt;&lt; header;
 }
};

#define TODO_HELPER_2(X, file, line) \
 static Error::ToDo_helper tdh##line(X, file, line)

#define TODO_HELPER_1(X, file, line) TODO_HELPER_2(X, file, line)
#define ToDo(X) TODO_HELPER_1(X, __FILE__, __LINE__)
</code></pre>

... and you use it like this:

<pre><code> void some_unfinished_business() {
 ToDo("Take care of unfinished business");
 }
</code></pre>

blocks|key|1462276|text|我使用//+TODO:或//+HACK:来提醒某些事情尚未完成，并给出一个注释来解释原因。由于时间限制，我经常(读到“很少”)回去完成那些事情。但是，当我查看代码时，我会记录下未完成的内容，以及更重要的原因。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1462277|我经常在一天或一周结束时使用的另一条评论是：|1462278|//从这里开始CHRIS|1462279|%5E告诉我我从哪里开始的，这样我就可以在星期一早上最小化我的引导时间。|1462280|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|J|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|K|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|L|8|@]|9|@]|A|$]]|$1|F|3|G|5|6|7|M|8|@]|9|@]|A|$]]|$1|H|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|I|$]]

I use // TODO: or // HACK: as a reminder that something is unfinished with a note explaining why.
I often (read 'rarely') go back and finish those things due to time constraints.
However, when I'm looking over the code I have a record of what was left uncompleted and more importantly WHY.

One more comment I use often at the end of the day or week:

// START HERE CHRIS

^^^^^^^^^^^^^^^^^^^^
Tells me where I left off so I can minimize my bootstrap time on Monday morning.

blocks|key|1462495|text|我使用//FIXME:+xxx表示损坏的代码，使用//CHGME:+xxx表示需要注意但可以正常工作的代码(可能只在有限的上下文中)。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1462496|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

I use //FIXME: xxx for broken code, and //CHGME: xxx for code that needs attention but works (perhaps only in a limited context).

blocks|key|1677851|text|这并不是一个完美的世界，我们并不总是有无限的时间来重构或思考代码。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1677852|有时我会在代码中放入//REVIEW，如果我想稍后再来讨论它的话。也就是说，代码正在工作，但可能不相信这是最好的方式。|offset|length|style|CODE|1677853|//+REVIEW+-+RP+-+Is+this+the+best+way+to+achieve+x?+Could+we+use+algorithm+y?|code-block|syntax|javascript|1677854|//REFACTOR也是如此|1677855|//+REFACTOR+-+should+pull+this+method+up+and+remove+near-dupe+code+in+XYZ.cs|1677856|entityMap^0|0|A|8|0|0|0|A|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|T|8|@$D|U|E|V|F|G]]|9|@]|A|$]]|$1|H|3|I|5|J|7|W|8|@]|9|@]|A|$K|L]]|$1|M|3|N|5|6|7|X|8|@$D|Y|E|Z|F|G]]|9|@]|A|$]]|$1|O|3|P|5|J|7|10|8|@]|9|@]|A|$K|L]]|$1|Q|3|-4|5|6|7|11|8|@]|9|@]|A|$]]]|R|$]]

It's not a perfect world, and we don't always have infinite time to refactor or ponder the code.

I sometimes put <code>//REVIEW</code> in the code if it's something I want to come back to later. i.e. code is working, but perhaps not convinced it's the best way.

<pre><code>// REVIEW - RP - Is this the best way to achieve x? Could we use algorithm y?
</code></pre>

Same goes for <code>//REFACTOR</code>

<pre><code>// REFACTOR - should pull this method up and remove near-dupe code in XYZ.cs
</code></pre>

blocks|key|1461706|text|Todo注释。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1461707|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

blocks|key|1677474|text|//+TODO:+<explanation>|type|code-block|depth|inlineStyleRanges|entityRanges|data|syntax|javascript|1677475|如果它是我还没有实现的东西，并且不想忘记的话。|unstyled|1677476|//+FIXME:+<explanation>|1677477|如果这是我认为不正确的东西，并希望稍后再来或让其他人查看它。|1677478|从来没有想过#error/#warning选项。这些也能派上用场。|1677479|entityMap^0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$B|C]]|$1|D|3|E|5|F|7|P|8|@]|9|@]|A|$]]|$1|G|3|H|5|6|7|Q|8|@]|9|@]|A|$B|C]]|$1|I|3|J|5|F|7|R|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|S|8|@]|9|@]|A|$]]|$1|M|3|-4|5|F|7|T|8|@]|9|@]|A|$]]]|N|$]]

<pre><code>// TODO: &lt;explanation&gt;
</code></pre>

if it's something that I haven't gotten around to implementing, and don't want to forget.

<pre><code>// FIXME: &lt;explanation&gt;
</code></pre>

if it's something that I don't think works right, and want to come back later or have other eyes look at it.

Never thought of the #error/#warning options. Those could come in handy too.

blocks|key|1677761|text|如果是一些long+term+technical+debt，你可以这样评论：|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1677762|//+TODO:+This+code+loan+causes+an+annual+interest+rate+of+7.5%25+developer/hour.+Upfront+fee+as+stated+by+the+current+implementation.+This+contract+is+subject+of+prior+authorization+from+the+DCB+(Developer's+Code+Bank),+and+tariff+may+change+without+warning.|style|CODE|1677763|..。错误。我猜TODO可以做到这一点，只要你不是简单地忽略它们。|1677764|entityMap|0|LINK|mutability|MUTABLE|url|http://blogs.construx.com/blogs/stevemcc/archive/2007/11/01/technical-debt-2.aspx^0|5|O|0|0|0|74|0|0^^$0|@$1|2|3|4|5|6|7|R|8|@]|9|@$A|S|B|T|1|U]]|C|$]]|$1|D|3|E|5|6|7|V|8|@$A|W|B|X|F|G]]|9|@]|C|$]]|$1|H|3|I|5|6|7|Y|8|@]|9|@]|C|$]]|$1|J|3|-4|5|6|7|Z|8|@]|9|@]|C|$]]]|K|$L|$5|M|N|O|C|$P|Q]]]]

If it's some <a href="http://blogs.construx.com/blogs/stevemcc/archive/2007/11/01/technical-debt-2.aspx" rel="nofollow noreferrer">long term technical debt</a>, you can comment like:

<code>// TODO: This code loan causes an annual interest rate of 7.5% developer/hour. Upfront fee as stated by the current implementation. This contract is subject of prior authorization from the DCB (Developer's Code Bank), and tariff may change without warning.</code>

... err. I guess a TODO will do it, as long as you don't simply ignore them.

blocks|key|1677684|text|除了关闭"TODO:“注释之外，许多IDE还关闭了"TASK:”注释。一些IDE甚至允许您配置自己的特殊标识符。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1677685|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

Besides keying off the "TODO:" comment, many IDE's also key off the "TASK:" comment. Some IDE's even let you configure your own special identifier.

In C# I use the <code>#warning</code> and <code>#error</code> directives,

<pre><code>#warning This is dirty code...
#error Fix this before everything explodes!
</code></pre>

This way, the compiler will let me know that I still have work to do. What technique do you use to mark code so you won't forget about it?

How do you flag code so that you can come back later and work on it?

Visual Studio

编译器

Eclipse

Java

在C#中，我使用#warning和#error指令，#warning This is dirty code...#error Fix this before everything explodes!这样，编译器就会让我知道我还有工作要做。你使用什么技术来标记代码，这样你就不会忘记它？

问如何标记代码，以便以后可以回来处理它？
EN

回答 18

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何标记代码，以便以后可以回来处理它？EN

回答 18

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何标记代码，以便以后可以回来处理它？
EN