ToniaSanzo / Move-TODOBlocks

Move-TODOBlocks saves TODO block comments to a TODO.shelf file, and moves TODO block comments from a TODO.shelf back to source code.

Move-TODOBlocks

Move-TODOBlocks is an organization tool!

What is a TODO Block comment?

A TODO Block comment is a double-slash \\ comment that starts with TODO: and ends with :TODO

Move-TODOBlocks.ps1 Work Flow

The work flow of Move-TODOBlocks is to add TODO Block comments to your source code. Then when you shelve those TODO Block comments into a TODO.shelf. Then after the commit/push you unshelve the TODO Block comments.

Shelving example:

In the PowerShell terminal you can run the script with the -Shelve flag to shelve your TODO blocks.

PS> .\Move-TODOBlocks.ps1 -Path "X:\SourceCodeRootDir" -Shelve

Unshelving example:

In the PowerShell terminal you can run the script with the -Unshelve flag to unshelve your TODO blocks.

PS> .\Move-TODOBlocks.ps1 -Path "X:\SourceCodeRootDir" -Unshelve