Skip to Content
Learn Red ? Fundamentals of Red
book

Learn Red ? Fundamentals of Red

by Ivo Balbaert
May 2018
Beginner content levelBeginner
252 pages
6h 19m
English
Packt Publishing
Content preview from Learn Red ? Fundamentals of Red

Code style and documentation strings

When a function starts to get more complex, incorporating arguments, refinements, return values, and so on, its code must stay readable, following a standard layout. Also, when used in production, functions and all their parts should have documentation. We can provide this with docstrings.

Here is how a general function should be styled:

func-name: func [        "Comments for the function itself"        arg1    [type1!] "Describe 1st argument"        arg2    [type2!] "Describe 2nd argument"        /ref1            "Describe refinement"                argref1 [type1]         return: [type3!] "Describe return value" ][     ; function body]

Here is a fully documented function in the standard layout:

max: function [        "Return the maximum of 2 numbers" arg1 [number!] "First number ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

How I Built a Personal Board of Directors With GenAI

How I Built a Personal Board of Directors With GenAI

Vipin Gupta
How to Become a Game-Changing Leader

How to Become a Game-Changing Leader

Douglas A. Ready, Alan Mulally
Why AI Demands a New Breed of Leaders

Why AI Demands a New Breed of Leaders

Faisal Hoque, Thomas Davenport, Erik Nelson

Publisher Resources

ISBN: 9781789130706Supplemental Content