Rinci Language-neutral metadata for your code
Download

Rinci Ranking & Summary

Rinci Tags

Perl module perl metadata neutral

Rinci Description

Rinci is a set of Perl specifications of metadata for your code entities. Each different type of code entity, like function/method, variable, namespace, etc, has its own metadata specification.Metadata is a set of name/value pairs stored in a regular mapping variable (a.k.a. hash in Perl/Ruby, or dictionary in Python, or array in PHP, or object in JavaScript/JSON; but from here on the term hash will be used). Each specification will describe what metadata property names (a.k.a. hash keys) are known and what value should each property contain. So the Rinci::function specification will describe metadata for functions/methods, Rinci::package will describe metadata for namespace/package, and so on.Rinci defines properties pertaining to documentation (like summary, description, examples, links), function argument and return value validation (args and result), dependencies (deps), standardized feature description (features), also a few conventions/protocols for doing stuffs like undo (others like callback/progress report will follow). Basically anything that can describe the code entity. The specification is extensible: you can define more properties, or more deps, or more features.Product's homepage

Rinci Related Software