code-brainstorming

Jump to: navigation, search

Contents

Code Brainstorming

This is a brainstorm for the code microformat. See also examples of code in the wild.

The Problem

There are numerous sites on the Internet that seek to:

Examples are:

Each of these sites encapsulates their source code in different fashions and wraps up the metadata in different ways, this makes the source code found around the web largely indigestible by machines.

So by consolidating common practices into a standard format, you a) allow web developers a standard representation of source code online, and b) offer it in a format that is digestible by computers. This more than anything allows for interesting use by users. It would for instance allow users to collect code examples from the web and store them on their local machines in meaningful ways, which in turn allows them to organize and search that new source code repository for examples, classes or snippets that relate to their problem, and further gives them the information necessary to safely use that source code (license, author, language, etc.)

Elements that come up often in practice

Base Elements

Strawman Outline

Additional Suggestions

(X)HTML already contains a number of elements relevant to marking up code:

Although there is probably some value in a code microformat, the effort should be careful to reuse these existing elements before inventing new methods of marking up code.

Issues

See also

code-brainstorming was last modified: Wednesday, February 4th, 2009

Views