CodeEditApp / CodeEditApp/CodeEditSourceEditor

✨ Comment Styles

Open
#260 0 comments 0 reactions 1 assignee Claimed by @tom-ludwig View on GitHub
enhancement wontfix
Dominant language
Swift
Stars
719
Forks
160
PR merge metrics
No merged PRs in 30d

Description

### Description

Comment characters currently start before the first visible character. In Xcode they are instead of at the beginning of a line. Users may prefer one commenting style over the other. We should provide a setting to toggle between these two commenting styles.

### Setting Option

Name: Comment style

Options:
- At beginning of line (default)
- After leading whitespace

> [!NOTE]
> The current behavior is "After leading whitespace" but there is no space after the comment characters. We should include this space. If multiple lines are commented out, comments should be at the same tab level.

### At beginning of line

#### Single line

```swift
func add(a, b) {
func result(a, b) {
// return a + b
}
return result(a, b)
}
```

#### Multi line

```swift
func add(a, b) {
// func result(a, b) {
// return a + b
// }
return result(a, b)
}
```

### After leading whitespace

#### Single line

```swift
func add(a, b) {
func result(a, b) {
// return a + b
}
return result(a, b)
}
```

#### Multi line

```swift
func add(a, b) {
// func result(a, b) {
// return a + b
// }
return result(a, b)
}
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.