I am not that good at computers but am trying to use JSDoc for one of my projects,
The tutorial to get it up and running is here
http://usejsdoc.org/about-jsdoc3.html
I have downloaded the program from github, but now do not understand what I have to do. I have a bunch of files in a folder and dont know how to get it actually running for my project.
Could someone please give me a step by step instruction on how to actually get JSDoc working, how do I set it up, how do I use it etc.
I know this may be mundane to some of you, but hey we all gotta start somewhere right?
Well, are you using windows or GNU/Linux?
First, you have to follow the default tags to markup your source code, identifying your classes, methods, parameters, etc...
After that, you download the file here: https://github.com/jsdoc3/jsdoc
Extract it and then go to folder jsdoc-master.
Inside it, you have a script called jsdoc (with no extension). Only you have to do is execute it pointing the whole path to your .js file you want to create a documentation like this: ./jsdoc your_class.js
Then, in a couple minutes you'll have the output inside the 'out' folder. Open the .html file and bang! You have your documentation working pretty good.
Right here you can find some common tags to use in your code (as comments): http://usejsdoc.org/
This solution is for Unix based system. But, there is another one using nodejs (that you can run with windows, Linux, mac, etc...). First, download the nodejs here: http://nodejs.org/
Then go to this website to take a look at the package jsdoc: https://npmjs.org/
Then, go back to your terminal (in any operating system after installed node) and type: npm install -g jsdoc
The option -g means globally, so you have inside the main folder of your node packages and they are available for whatever project you have and you don't need to install it again and again...
Finally, you can just use this command: jsdoc path/to/your/file.js
And that's it! I hope it helps you.
Once you've extracted the file you downloaded off of github, navigate within the folder and run in a terminal:
./jsdoc
with the options you want.
If you want to display the help menu
./jsdoc --help
If you want to install the program on your system, assuming a mac or linux machine, use root user or sudo:
npm install --save -g [~/Downloads/jsdoc-3.2.2 or your path to the downloaded extracted files]
Related
I want to build a site similar to this one.
So I downloaded the source code from https://github.com/larskarbo/napchart on my Windows 10 machine, but I don't know how to execute the thing and see it running in a page so I can play with the code and see how it is working.
I have node.js installed but I am not sure of how to use it, so detailed instructions are welcomed
Also, I tried saving the code from the site directly by clicking Save As but it didn't work though. Why is that happening?
Considering napchart has been pushed to the npm registry, you shouldn't need to interact with its source code directly.
As per your second question, I don't advise to download any of it manually. Running npm install napchart --save in your project directory should get you going.
That being said, the author also published the source of https://napchart.com/app, which can help you bootstrap your project.
I have a trouble when I want to run locally an azure function in vscode or vs enterprise 2017, the error is:
I tried this and nothing work:
Create a mklink to replace special characters in my name to can
find the path.
Change the route of the npm azure tools, so when I execute the
command: npm root -g the path is a custom path that I created to the
test, but the application still try to find in the error path.
The main error is the special symbols in my user name, the accent mark.
I don't know what I can do, sorry for my bad english
This issue is in the underlying dependencies of the core-tools, namely https://github.com/Azure/azure-functions-host which is using edgejs. And from this thread, you could try to download a zipfile manually from the URL specified here: https://aka.ms/functions-cli or download from the releases page: https://github.com/Azure/azure-functions-cli/releases, then install this tool in a different folder.
My username also caused me the same problem and I didn't know how to make Visual Studio read the Functions Tools files from another folder.
What solved the problem for me was to move the cli_x64 and templates -folders (in path_to_azFuncTools/releases/1.10.0) to a directory without a problematic username (e.g. C:\Users\Default\AppData\AzureFunctionsTools).
Then, in path_to_azFuncTools/releases/1.10.0/manifest.json, I changed the fields "CliEntrypointPath" and "TemplatesDirectory" to correspond to the new file path and it started working.
i've installed jshint using npm install -g jshint and i want to know where is the .jshintrc file is located - the default location for that file.
I have go through the docs: http://jshint.com/docs/ and i saw the paragraph about where it search for that file. but runnig find . -name .jshintrc in my home directory only find rc files that are in node_modules directories, so i don't understand where jshint get his configuration from.
I also searched the /usr/lib/node_modules/jshint - this is where the jshint is installed globally and no luck there , can anyone point me to that information??
As far as I know no file is added by installing jshint (example linked below). Normally, you would put the “.jshintrc” in the source code root for the project. This way it’s easily discoverable by others. Then each project applies it’s own set of rules. These kind of files typically applies recursively in the folders below.
But they can be put deeper in folder structure as well. This could be useful in cases where backend and clients use different rules, or when backend is written in another programming language.
Here is an example of such a file:
https://github.com/jshint/jshint/blob/master/examples/.jshintrc
Best of luck.
'sails' is not recognized as an internal or external command,
operable program or batch file.
So basically I use Windows 10 and I need Sails up and running. I saw on YT people working with that with no problems. I really wanna use Sails.js because it's amazing but I cannot use it.
I don't know what's wrong. I'm doing everything like they say to do. I've installed it globally through npm and of course, I have Node installed and still, I have that error...
What should I do?
It looks like you are missing the path to the sails script in the PATH environment variable. What you can do is find where your sails have been installed:
dir sails.cmd /s
After you find it, open windows menu and type directly 'env' and then select 'Edit the system environment variables'. In the opened window click on the 'Environment variables...' button and add the path to the 'Path' variable.
However, a more preferable way is to uninstall everything (node included) and use the nvm (Node Version Manager) program to get the node itself. You can find it here:
https://github.com/coreybutler/nvm-windows/releases
Then use it to get the node version you want. It is a very useful tool to quickly change between node versions. After that install sails as usual and you should be good to go.
To install the package with the atmosphere in meteor.js sufficient to use a single command. But let us assume that there is a need to edit a specific package for themselves. Now I needed to translate into another language package accounts-ui-bootstrap. Package code is in the appropriate folder in the directory .meteor. Everything works as it should, but after restarting the application server, all changes are rolled back to its original state. What should I do?
Just add a new JS or CSS file on your public/server folder depends the case, and overwrite it