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.

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

Match more docstrings #141

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hristost
Copy link

@hristost hristost commented Dec 28, 2019

Previously, certain keywords in comments would be left unmatched if the docstring was written as multiple single-line comments or if the comments began with an asterisk. For example:

/**
 * Function description
 * - Parameter a: parameter description
 * - Returns: return value description
 */

or

/// Function description
/// - Parameter a: parameter description
/// - Returns: return value description

This pull request fixes that, and furthermore introduces two new syntax groups: swiftDocStringParam, which matches parameter names in docstrings, and swiftDocStringInlineCode which matches text surrounded by back-ticks in comments. Those two groups are highlighted with SpecialComment by default, but by overriding them users should be able to get closer to the way Xcode displays comments.

Below is a screenshot with the improved highlighting:
Screen Shot 2019-12-28 at 12 20 11
Note how - Returns and - Parameter are highlighted in bold, and the parameter name and the zero in the last line are highlighted in a lighter colour.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant