You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/src/manual/style-guide.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,11 @@ Julia's compiler works.
19
19
It is also worth emphasizing that functions should take arguments, instead of operating directly
20
20
on global variables (aside from constants like [`pi`](@ref)).
21
21
22
+
## Write docstrings
23
+
24
+
Comments describing an object should typically be written as [docstrings](@ref man-writing-documentation) for editor and REPL accessibility.
25
+
Inline comments (`# comment`) and multiline comments (`#= comment =#`) are appropriate for information that is intended only for the reader of the code (as opposed to a user).
26
+
22
27
## Avoid writing overly-specific types
23
28
24
29
Code should be as generic as possible. Instead of writing:
0 commit comments