Code comments
Comments for follow-up actions
Whenever you add comments to the code that are expected to be addressed in the future, create a technical debt issue. Then put a link to it to the code comment you’ve created. This allows other developers to quickly check if a comment is still relevant and what needs to be done to address it.
Examples:
# Deprecated scope until code_owner column has been migrated to rule_type.
# To be removed with https://gitlab.com/gitlab-org/gitlab/-/issues/11834.
scope :code_owner, -> { where(code_owner: true).or(where(rule_type: :code_owner)) }
Class and method documentation
Use YARD syntax if documenting method arguments or return values.
Example without YARD syntax:
class Order
# Finds order IDs associated with a user by email address.
def order_ids_by_email(email)
# ...
end
end
Example using YARD syntax:
class Order
# Finds order IDs associated with a user by email address.
#
# @param email [String, Array<String>] User's email address
# @return [Array<Integer>]
def order_ids_by_email(email)
# ...
end
end
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support