Comments (3)
Naive question: What's the benefit to using JSDoc?
from civ-clicker.
- Using JSDoc conventions, each argument to functions would be document with
@param
. Return values would use@return
. These conventions are used for PHPDoc and Java, too (and maybe other languages), making it easy to read and get an overview. It's especially useful for dynamically typed language, where the type of an argument might not be obvious (depending on naming conventions etc). - JSDoc can generate documentation docs. Not sure if we need that.
from civ-clicker.
It's google approved (https://google.github.io/styleguide/jsguide.html#jsdoc); I think it's a good idea.
from civ-clicker.
Related Issues (20)
- Debug/test mode
- Gold
- Educational information HOT 6
- Climate
- Multiplayer
- Disable console to prevent hacking HOT 1
- Config file HOT 1
- Using ES6
- Leader board
- gatherers can not be removed or added to HOT 1
- Add a "Add all unemployed workers" button HOT 1
- Ability to hide some labels HOT 1
- Bug with sick citizens
- Cats do not heal sick citizens HOT 1
- Ore goes to metal before the monument HOT 6
- Happyness of people HOT 1
- Dark Mode HOT 1
- idea HOT 3
- Battle Standard resource requirements are far too high for 100 building limit
- Bandits attack too frequently on recent patch, unable to maintain soldier production.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from civ-clicker.