Languages Features Creators CSV Resources Challenges Add Language
GitHub icon

Doc comments

Doc comments - language feature

< >
Example from F#:
/// Adds 2 numbers let rec add x y = x + y
Example from PureScript:
-- -- | `bool` performs case analysis for the `Boolean` data type, like an `if` statement. bool :: forall a. Boolean -> a -> a -> a bool true x _ = x bool false _ x = x
Example from C3:
/** * @param [in] foo "The foo value" * @return "the toal foo count" **/
Example from Speedie:
function Find (|string| pattern, |int| pos=0, |int|) description "Returns the position of pattern in self, starting from 'pos'. If not found, we return -1."
Example from Jule:
// Documentation comment for a_function fn a_function() {}

Languages with Doc comments include F#, PureScript, C3, Speedie, Jule

This question asks: Is there a standard mini language written in comments for documenting code?

HTML of this page generated by Features.ts

hasDisposeBlocks.html 路 hasDocComments.html 路 hasDuckTyping.html

View source

- Build the next great programming language Search Day 214 About Blog Acknowledgements Traffic Traffic Today GitHub