node.js üzerinde çalışan scriptimde jsdoc nasıl kullanılır?

Bazı kaynak kodlarından belge girişlerini ayıklamak için jsdoc modülünü kullanmak istiyorum. jsdoc modülünü yükledim ve komut satırında jsdoc'u kullanabilirim. Ama benim kodumda require("jsdoc"), nodejs Cannot find module 'jsdoc' diyerek bir hata atar.node.js üzerinde çalışan scriptimde jsdoc nasıl kullanılır?

nodejs v0.8.25 ve JSDoc 3.3.0-alpha2 var. Hem yerel hem de global olarak kurulur. jsdoc komutunu kullanabilir ve node_modules klasöründe jsdoc var. Sorunun nerede olduğunu göremiyorum.

jsdoc ile ilgili bazı belgeleri, komut satırı arabiriminde nasıl kullanacağını veya js kaynak kodunu nasıl belgeleyeceğinizi öğrenebilirsiniz. Bazı API belgeleri istiyorum.

kaynak

2013-11-28 Richard Dong

jsdoc'u nasıl yüklediniz? npm jsdoc --save'yi kuruyor mu? Ayrıca, tam bir sidenote olarak, muhtemelen düğümünüzü en son 0.10.2x –

'a güncellemek istiyorum. En son nodejs sürümüne geçiyorum ve jsdoc'u tam olarak bu komutla yüklüyorum. Komut satırı arayüzünde kullanabilirim. Komutumda bu modülü hala kullanamıyorum. –

, "npm install jsdoc --save" komutunu "node_modules" dizininizde bir "jsdoc" dir olup olmadığını belirtmek için postanızı güncelleyebilir misiniz? –

-3

Genelde otomatik bir belge aracıyla ilgili ise, YUIDoc'u da kullanabilirsiniz.

kurduğunuzda: sizin JS kaynak ağacının tepesine konsol vadede yuidoc . yılında YUIDoc Syntax Reference
ilgili npm -g install yuidocjs
Biçim Yorumlarınızı Bu üç adımı takip

, kendi otomatik belgelere sahip olacaktır

kaynak

2013-11-28 07:51:24

Soru, özellikle JSDoc hakkında ..benzer olsa da, JSDoc ve YUIDoc farklı dokümanlar kullanır ve gerektirir (ve JSDoc "kod denetimi" ni destekler). – user2864740

Jsdoc'ı doğru şekilde yüklemediniz gibi görünüyor. Komut satırından npm install -g jsdoc'u çalıştırın. Bunu varsayılan dizinde bulunan yeni bir terminal penceresi içinde çalıştırırsanız, herhangi bir sorunla karşılaşmamalısınız. Şu anki çalışma dizinimden global olarak bir düğüm modülü kurmaya çalıştığım ve modülün dünya çapında yükleme yapmasına gerek yok.

kaynak

2013-11-28 08:21:51 leaksterrr

Bir kütüphane olarak jsdoc'u da kullanmayı düşünüyordum ve yaptığınız gibi aynı konuda tökezledim. Yanlış bir şey yapmadınız, sadece kütüphane olarak kullanılmak üzere tasarlanmamıştı.

İlgili jsdoc github proje sayfasında an issue var. Hegemonic, JSDoc ana katkıyı söyledi:

JSDoc gerçekten bir kütüphane olarak kullanılmak üzere tasarlanmamıştır

Sen konuyla ilgili nodejs için bir API oluşturmak için arzunuzu ifade etmek isteyebilirsiniz

yukarıda bağlantılı. Jsdoc'un package.json numaralı telefonunda bildirilen main alanı olmadığından require('jsdoc'), require('jsdoc') başarısız olur. Varsayılan olarak 'index.js' veya 'main.js' olabilir, ancak böyle bir dosya yoktur.

kaynak

2013-12-11 15:32:26

node.js üzerinde çalışan scriptimde jsdoc nasıl kullanılır?

cevap

İlgili konular