saveourtool/diktat

Multiline TODO/FixME

Open

#969 建立於 2021年7月7日

在 GitHub 查看
 (1 留言) (0 反應) (1 負責人)Kotlin (40 fork)github user discovery
enhancementgood first issue

倉庫指標

Star
 (571 star)
PR 合併指標
 (PR 指標待抓取)

描述

It could be useful to process multiline comments, marked as TODO or FixME as follows:

// TODO: comment1
// comment2
// comment3

Change to

// TODO: comment1
// TODO: comment2
// TODO: comment3

Details

IDEA have logic for highlighting with blue all lines, only if lines starting from the second have extra spaces at the beginning:

// TODO: comment
//  now it's highlights too

But by default only line with TODO/FixME keyword will be highlighted.

However, it's not good approach to add extra space during the fix, since after when TODO/FixME will be done, there is a big chance, that developer will remove only the first line from TODO/FixME comment, since only it was highlighted. In aim to avoid this, we need to add TODO/FixME on each line

貢獻者指南