Mailing-List: contact user-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: user@couchdb.apache.org
Received-SPF: pass (athena.apache.org: domain of st.fankl.in@gmail.com
 designates 209.85.214.42 as permitted sender)
MIME-Version: 1.0
In-Reply-To: <52AB31CB.2090604@zynstra.com>
References: 
 <CAA=cwqHr-O-pOmQtGocorK0vDgJBCjGjSXm=0MQX9s0uuc529g@mail.gmail.com>
	<52AB31CB.2090604@zynstra.com>
Date: Mon, 16 Dec 2013 16:02:53 +0100
Message-ID: 
 <CAA=cwqE9vEcq0BTpgFjcBhrpGqgR0U1Aj-WA54yeVGhLAtELsw@mail.gmail.com>
Subject: Re: How do you document your document structure?
From: Stefan Klein <st.fankl.in@gmail.com>
To: user@couchdb.apache.org
Content-Type: multipart/alternative; boundary=047d7beb9076377fc104eda81b36

--047d7beb9076377fc104eda81b36
Content-Type: text/plain; charset=ISO-8859-1

2013/12/13 James Dingwall <james.dingwall@zynstra.com>

> Stefan Klein wrote:
>
>> all over my javascript source i got statements like
>> if (doc.field === 'VALUE') {
>> }
>> somewhere else:
>> if (doc.field === 'VALUE2') {
>> }
>>
>> what id like to have is something like jsdoc which parses my source and
>> tells me which fields i use and which values i expect. (Would be easy to
>> spot typos etc. this way)
>> I tried jsdoc, created fake classes, it kind of works but is ugly.
>>
>> Is there a better tool?
>>
>  We are using json-schema to document our structure and have imported the
> tv4 validator to perform validation tasks within couchdb.  You can use
> views to emit documents not conforming to the schema, reject non conforming
> documents in validate_doc_update....  The json schema allows us to add
> extra metadata around the various fields that say what they are for and we
> could pull out such comments when building a ui to edit a document.
>

Thank you, thats probably a better approach than in-code documentation.

--047d7beb9076377fc104eda81b36--