✨ Comment Styles
@tom-ludwig is already working on this.
Since Aug 20, 2024.
Assessment
This issue has not been assessed yet.
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
func add(a, b) {
func result(a, b) {
// return a + b
}
return result(a, b)
}
Multi line
func add(a, b) {
// func result(a, b) {
// return a + b
// }
return result(a, b)
}
After leading whitespace
Single line
func add(a, b) {
func result(a, b) {
// return a + b
}
return result(a, b)
}
Multi line
func add(a, b) {
// func result(a, b) {
// return a + b
// }
return result(a, b)
}
- Dominant language
- Swift
- Stars
- 720
- Forks
- 162
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from CodeEditApp/CodeEditSourceEditor
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
CodeEditApp/CodeEditSourceEditor#377 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
CodeEditApp/CodeEditSourceEditor#376 · 1 comment ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
CodeEditApp/CodeEditSourceEditor#378 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
All issues in CodeEditApp/CodeEditSourceEditor
Similar issues
-
area:dictation documentation P2
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
uttrflow/uttrflow-swift#1180 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
OneBusAway/onebusaway-ios#1451 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100