Comments/KDoc indentation not checked

[jfresen]

In the following code, only the last two errors in indentation are detected:

fun foo() {               
    /**
       * not detected
     */
    /*
       * not detected
     */
    //
      // detected
    //
    var foo = 1
      foo += 1 // detected
    foo -= 1
}

[shyiko]

ktlint -F --experimental (since ktlint@0.31.0) produces

fun foo() {
    /**
     * not detected
     */
    
    /*
       * not detected
     */
    //
    // detected
    //
    var foo = 1
    foo += 1 // detected
    foo -= 1
}

/**/ content is not checked because it's essentially freeform. I suppose we can check whether all !blank lines start with * and align them if they are but it's not implemented yet.

[yukukotani]

@shyiko You mean the code below should be allowed?

fun foo() {
    /*
            * comment
     */
}

In my opinion, the text in comment should be freeform, but starting * should be aligned.

fun foo() {
    /*
     * ugly
     *         indent
     *    in comment
     * should be allowed
     */
    /*
     * ugly
           * indent
       * of comment head
     * should not be allowed
     */
}

[Tapchicoma]

I would agree that * should be aligned and have whitespace after, then text could be free-form.

[paul-dingemans]

The issue still (partly) exists in current 0.44.0 version. The KDoc and EOL comments are fixed. The incorrectly indented block comment is still undetected. Original example is now formatted as:

fun foo() {
    /**
     * not detected
     */
    val bar = 1
    /*
       * not detected
     */
    //
    // detected
    //
    var foo = 1
    foo += 1 // detected
    foo -= 1
}

[matthewadams]

It'd be nice if this also hard-wrapped KDoc (Javadoc) lines at some standard margin.

So that, with an 80-character margin for example,

/**
 * This is a really really really really really really really really really really really really really really really really really long line.
 */

is reformatted to

/**
 * This is a really really really really really really really really really
 * really really really really really really really really long line.
 */

[paul-dingemans]

It'd be nice if this also hard-wrapped KDoc (Javadoc) lines at some standard margin.

So that, with an 80-character margin for example,

/**
 * This is a really really really really really really really really really really really really really really really really really long line.
 */

is reformatted to

/**
 * This is a really really really really really really really really really
 * really really really really really really really really long line.
 */

This is not related to the original issue. Also, I don't think that KDOC should be wrapped. If you really would like to have such functionality it is best to write a custom rule for it. See https://pinterest.github.io/ktlint/api/custom-rule-set/ for a starting point to create a custom rule.