2013/12/13 James Dingwall <[email protected]> > 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.
