CanExplainExtensions

Namespace: SnowBank.Runtime · class

Extensions methods for ICanExplain types

Methods

Explain

static string Explain(ICanExplain node, bool recursive = true, string prefix = null)

Returns a human-readable description of what this node does

  • node — Node that should explain itself
  • recursive — If true (default), also explain any children of this node; otherwise, only give a brief one-line summary.
  • prefix — Prefix added to the beginning of each line

Returns: Description of this node

The text will usually end with an extra newline (\r\n)