Skip to main content
Software Engineering

Return to Question

Removed request for references, since that is off topic, but the rest of the question appears fine.
Source Link
Greg Burghardt
Greg Burghardt
  • 46.5k
  • 8
  • 87
  • 150

I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means.

E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT

Is there a distinction in the # and :: notation, does it say whether one method is an instance method, a static method, a variable, etc.?

Are there any other notations that can help me write cleaner pull request summaries, documentation or commit messages when referring to classes/methods and instance variables/constants? While also allowing me to be specific on typing and syntax when referencing the code?

Any resources about this topic is much appreciated!

I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means.

E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT

Is there a distinction in the # and :: notation, does it say whether one method is an instance method, a static method, a variable, etc.?

Are there any other notations that can help me write cleaner pull request summaries, documentation or commit messages when referring to classes/methods and instance variables/constants? While also allowing me to be specific on typing and syntax when referencing the code?

Any resources about this topic is much appreciated!

I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means.

E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT

Is there a distinction in the # and :: notation, does it say whether one method is an instance method, a static method, a variable, etc.?

Are there any other notations that can help me write cleaner pull request summaries, documentation or commit messages when referring to classes/methods and instance variables/constants? While also allowing me to be specific on typing and syntax when referencing the code?

added 11 characters in body
Source Link
Glorfindel
Glorfindel
  • 3.2k
  • 6
  • 28
  • 34

I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means.

E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT

Is there a distinction in the # and :: notation, does it say whether one method is an instance method, a static method, a variable, etc.?

Are there any other notations that can help me write cleaner pull request summaries, documentation or commit messages when referring to classes/methods and instance variables/constants? While also allowing me to be specific on typing and syntax when referencing the code?

Any resources about this topic is much appreciated!

I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means.

E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT

Is there a distinction in the # and :: notation, does it say whether one method is an instance method a static a variable etc?

Are there any other notations that can help me write cleaner pull request summaries, documentation or commit messages when referring to classes/methods and instance variables/constants? While also allowing me to be specific on typing and syntax when referencing the code?

Any resources about this topic is much appreciated!

I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means.

E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT

Is there a distinction in the # and :: notation, does it say whether one method is an instance method, a static method, a variable, etc.?

Are there any other notations that can help me write cleaner pull request summaries, documentation or commit messages when referring to classes/methods and instance variables/constants? While also allowing me to be specific on typing and syntax when referencing the code?

Any resources about this topic is much appreciated!

Source Link
GoldFlsh
GoldFlsh
  • 147
  • 4

Code reference symbols in documentation, comments and pull requests?

I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means.

E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT

Is there a distinction in the # and :: notation, does it say whether one method is an instance method a static a variable etc?

Are there any other notations that can help me write cleaner pull request summaries, documentation or commit messages when referring to classes/methods and instance variables/constants? While also allowing me to be specific on typing and syntax when referencing the code?

Any resources about this topic is much appreciated!