Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Wrap comments at 90 characters #5

Open
cbeams opened this issue Mar 16, 2018 · 0 comments
Open

Wrap comments at 90 characters #5

cbeams opened this issue Mar 16, 2018 · 0 comments

Comments

@cbeams
Copy link
Member

cbeams commented Mar 16, 2018

#3 specifies that code should be wrapped at 120 characters, but prose in the form of comments is hard to read at that width. 90 characters is an ideal wrap margin for Javadoc and other comments, as it strikes a good balance between readability and accommodating longer literals like fully-qualified classnames, URLs, and so forth without requiring wrapping. Also, the ratio between 120-character code lines and 90-character Javadoc lines is aesthetically pleasing on its own.

Unfortunately, IDEA does not (yet) support enforcing multiple wrap margins, e.g. one for code lines and one for comment lines like Eclipse has done for years. But recent IDEA versions do support multiple visual guides, e.g. one at 120 for code and one at 90 for Javadoc. Our common IDEA code styles configuration has been updated to introduce the 90-character visual guide as a reminder about this.

See:
cbeams added a commit to bisq-network/bisq-monitor-deprecated that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
d3ac6ff 
Per bisq-network/style#5
cbeams added a commit to bisq-network/bisq-common that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
69f0495 
Per bisq-network/style#5
cbeams added a commit to bisq-network/bisq-statsnode that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
1499ede 
Per bisq-network/style#5
cbeams added a commit to bisq-network/bisq-seednode that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
3817d0f 
Per bisq-network/style#5
cbeams added a commit to bisq-network/bisq-p2p that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
ca6a486 
Per bisq-network/style#5
cbeams added a commit to cbeams/bisq-pricenode that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
9ebf7d6 
Per bisq-network/style#5
cbeams added a commit to bisq-network/dao that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
5289a2e 
Per bisq-network/style#5
cbeams added a commit to bisq-network/bisq-core that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
e2c6d00 
Per bisq-network/style#5
cbeams added a commit to bisq-network/bisq that referenced this issue Mar 16, 2018
@cbeams
Add visual guide at 90-character Javadoc margin
730e583 
Per bisq-network/style#5
mrosseel pushed a commit to mrosseel/pricenode that referenced this issue Jun 12, 2018
@cbeams @mrosseel
Add visual guide at 90-character Javadoc margin
41796b9 
Per bisq-network/style#5
@cbeams cbeams changed the title Wrap Javadoc at 90 characters Wrap Javadoc and other comments at 90 characters May 8, 2020
@cbeams cbeams changed the title Wrap Javadoc and other comments at 90 characters Wrap comments at 90 characters May 11, 2020
cbeams added a commit to cd2357/bisq that referenced this issue May 11, 2020
@cbeams
Polish style
833b633 
 - Wrap comments at 90 chars per bisq-network/style#5
 - Wrap code at 120 chars per bisq-network/style#3
 - Remove unused imports
 - Remove extra newlines
 - Format code where appropriate
 - Remove unused Javadoc tags, e.g. @return, @param
 - End Javadoc summary sentence with a period where missing
 - Remove HTML formatting in Javadoc, e.g. extra <br>s
cbeams added a commit to cd2357/bisq that referenced this issue May 11, 2020
@cbeams
Polish style
f8c9c72 
 - Wrap comments at 90 chars per bisq-network/style#5
 - Wrap code at 120 chars per bisq-network/style#3
 - Remove unused imports
 - Remove extra newlines
 - Format code where appropriate
 - Remove unused Javadoc tags, e.g. @return, @param
 - End Javadoc summary sentence with a period where missing
 - Remove HTML formatting in Javadoc, e.g. extra <br>s
cbeams added a commit to ghubstan/bisq that referenced this issue May 18, 2020
@cbeams
Wrap comments at 90 chars
d53cc38 
Per bisq-network/style#5
@cbeams cbeams mentioned this issue Jun 17, 2020
Merged
cd2357 added a commit to cd2357/bisq that referenced this issue Jul 11, 2020
@cd2357
Wrap comments at 90 characters
7976798 
Update comments to reflect bisq-network/style#5 guideline
cd2357 added a commit to cd2357/bisq that referenced this issue Jul 20, 2020
@cd2357
Wrap comments at 90 characters
31b7206 
Update comments to reflect bisq-network/style#5 guideline
cd2357 added a commit to cd2357/bisq that referenced this issue Jul 20, 2020
@cd2357
Wrap comments at 90 characters
141ead0 
Update comments to reflect bisq-network/style#5 guideline
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cbeams