comment should start at the beginning of the line

[Spindyckx]

Description of the problem or steps to reproduce

when using the comment plugin, the comment character should be at the beginning of the line and not in front of the first word, this way it is more readable what is commented.

Specifications

Micro version: 2.0.10
Commit hash: b976385
OS: Arch
comment plugin version: 1.0.0
Terminal: Tilix 1.9.4

[ryleu]

You you mean like this:

def someFunc():
#    this prints some stuff
    print("some stuff")

Rather than this?

def someFunc():
    #this prints some stuff
    print("some stuff")

If so, I disagree. Ideally, in my opinion, it would do this:

def someFunc():
    # this prints some stuff
    print("some stuff")

[Spindyckx]

I disagree, the first example is much more readable. you see clearly see if whole blocks of text are commented by the comment character at the beginning of the line, the way i suggest is the same way vim, nano, vscode and probably other text editors do too. i get that people have preferences so maybe giving an option to do your way would be nice too

btw, i'm not talking about a single manually placed comment character here, i'm talking about selecting a block of text and pressing alt+/

[ryleu]

I like the idea of it being configurable. I prefer my comments on the same line as my code so they're grouped together. So maybe an edit to this issue to have it be something configurable rather than one way that some people don't like?

[Spindyckx]

i agree, configurability is always better (if the config is easy) and that way both groups are happy.

[dmaluka]

IMO comment should start in front of the first word, but in case of a multi-line block it should be the leftmost word of the whole block, i.e. the comment should start at the same position on each line.

I.e., if we use Alt-/ to comment the body of this function:

void somefunc(int a)
{
    if (a) {
        a += 2;
        printf("a = %d\n", a);
    } else {
        printf("none");
    }
}

currently it looks like this:

void somefunc(int a)
{
    // if (a) {
        // a += 2;
        // printf("a = %d\n", a);
    // } else {
        // printf("none");
    // }
}

It would be better if it looked like this instead:

void somefunc(int a)
{
    // if (a) {
    //     a += 2;
    //     printf("a = %d\n", a);
    // } else {
    //     printf("none");
    // }
}

[ryleu]

IMO comment should start in front of the first word, but in case of a multi-line block it should be the leftmost word of the whole block, i.e. the comment should start at the same position on each line.

I agree with your opinion.

I.e., if we use Alt-/ to comment the body of this function:

void somefunc(int a)
{
    if (a) {
        a += 2;
        printf("a = %d\n", a);
    } else {
        printf("none");
    }
}

currently it looks like this:

void somefunc(int a)
{
    // if (a) {
        // a += 2;
        // printf("a = %d\n", a);
    // } else {
        // printf("none");
    // }
}

The way it's doing it now is just generally gross.

It would be better if it looked like this instead:

void somefunc(int a)
{
    // if (a) {
    //     a += 2;
    //     printf("a = %d\n", a);
    // } else {
    //     printf("none");
    // }
}

This is much better. There should also be a way to comment it like this:

void somefunc(int a)
{
//  if (a) {
//    a += 2;
//    printf("a = %d\n", a);
//  } else {
//    printf("none");
//  }
}

Or like this:

void somefunc(int a)
{
  /*
  if (a) {
    a += 2;
    printf("a = %d\n", a);
  } else {
    printf("none");
  }
  */
}

All depending on how the user sets it. Multi-line comments might need to be a different bind though...

[rochacbruno]

Anyone found a solution for this issue?

I wanted this

    let result: u32 = io::stdin()
        .lines()
        // .filter_map(|line| match line {
            // Ok(line) => Some(line),
            // Err(_) => None,
        // })
        .collect::<Vec<String>>()

to be like this

    let result: u32 = io::stdin()
        .lines()
        // .filter_map(|line| match line {
        //     Ok(line) => Some(line),
        //     Err(_) => None,
        // })
        .collect::<Vec<String>>()

[dmaluka]

@rochacbruno I hope to find time to fix it, finally.

[xception]

@Spindyckx
You are absolutely wrong that comment should be at start of line.
Yes, one can work around it, get used to it or any other reasoning you can come up with and its identically efficient and works similar to comment before first character of the line but you are wrong.

One should not have to move his eyes left all the way away from code and figure out if its commented. the moment you do that manually, you defeat the purpose of not caring about it. it should be seemless and should take minimal effort, that what IDE's are designed for.

There is higher chance of human error in comment at start of line when it comes to large nested blocks with comments in it and why would you even move your eyes when you can simply focus on section of code you want to look at and KNOW that its commented at the same time.

From an engineering standpoint assuming a human is looking at the code, it should always be at start of the first letter of the line. now if VIM , NANO, or whatever does it that way, doesn't make that way right. it just makes it "ONE IS USED TO SUCH WAY" which I totally get it.