Difference between revisions of "IDE Window: ToDo List"

From Free Pascal wiki
Jump to navigationJump to search
m (Fixed syntax highlighting)
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{IDE Window: ToDo List}}
 
{{IDE Window: ToDo List}}
  
The todo list shows the list of ToDo comments of all files of the project units.
+
The todo list shows the list of ToDo comments of all project units.
  
At the moment it searches all units used in the .lpr file of the current project (including units from packages and excluding project units not used in the .lpr file). Eventually it should search all units of the project. A patch for this is welcome. See ide/todolist.pas procedure TfrmTodo.acGotoExecute.
+
Til Lazarus 1.6 it only searched the units listed in the project inspector. Since 1.7 it searches all used units (i.e. lpr uses section) too.
  
usage:
+
Make comments in source-code like these:
  
    List all to do comments of current project and the file projectname.todo.
+
<syntaxhighlight lang=pascal>
    {TODO -oOwnerName -cCategoryName: Todo_text}
+
{TODO -oOwnerName -cCategoryName: Todo_text}
    {DONE -oOwnerName -cCategoryName: Todo_text}
+
{DONE -oOwnerName -cCategoryName: Todo_text}
    {#todo -oOwnerName -cCategoryName: Todo_text}
+
{#todo -oOwnerName -cCategoryName: Todo_text}
    {#done -oOwnerName -cCategoryName: Todo_text}
+
{#done -oOwnerName -cCategoryName: Todo_text}
 +
{ ToDo: Todo_text}
 +
// ToDo: Todo_text
 +
(* ToDo: Todo_text *)
 +
</syntaxhighlight>
  
    the -o and -c tags are optional.
+
The -o and -c tags are optional.
  
== Refresh ==
+
= Controls =
  
Search again all files for ToDo comments and update the list.
+
Buttons:
 +
* Refresh: Search again all files for ToDo comments and update the list.
 +
* Goto: Jump to the item in the source editor.
 +
* Export: Make report of todo items in a CSV file.
 +
* Add source editor units: When enabled, scan the units in the source editor as well.
  
== Goto ==
+
Listbox:
  
Jump to the item in the source editor.
+
* Double click to jump to the item in the source editor.
 
 
== List ==
 
 
 
Double click to jump to the item in the source editor.
 
 
 
[[Category:Lazarus IDE plugins]]
 

Revision as of 09:47, 17 February 2020

Deutsch (de) English (en) suomi (fi) français (fr)

The todo list shows the list of ToDo comments of all project units.

Til Lazarus 1.6 it only searched the units listed in the project inspector. Since 1.7 it searches all used units (i.e. lpr uses section) too.

Make comments in source-code like these:

{TODO -oOwnerName -cCategoryName: Todo_text}
{DONE -oOwnerName -cCategoryName: Todo_text}
{#todo -oOwnerName -cCategoryName: Todo_text}
{#done -oOwnerName -cCategoryName: Todo_text}
{ ToDo: Todo_text}
// ToDo: Todo_text
(* ToDo: Todo_text *)

The -o and -c tags are optional.

Controls

Buttons:

  • Refresh: Search again all files for ToDo comments and update the list.
  • Goto: Jump to the item in the source editor.
  • Export: Make report of todo items in a CSV file.
  • Add source editor units: When enabled, scan the units in the source editor as well.

Listbox:

  • Double click to jump to the item in the source editor.