JSDoc VS Vim

• Improved Documentation
  JSDoc generates detailed HTML documentation from comments, which improves the maintainability and readability of the codebase.
• Enhanced Code Understanding
  By using JSDoc, other developers can easily understand the purpose and usage of functions, parameters, classes, etc.
• Autocomplete and Type Checking
  When integrated with editors like Visual Studio Code, JSDoc comments can provide better autocomplete suggestions and can be used for TypeScript-like type checking.
• Consistency
  JSDoc enforces consistent documentation across the codebase, ensuring that all parts of the code are equally documented.
• Easy to Use
  It is relatively straightforward to incorporate JSDoc comments into existing JavaScript code with minimal effort.
• Supports Multiple Formats
  JSDoc supports various formats and tags, making it versatile for different documentation needs.

Possible disadvantages

• Learning Curve
  New users may need some time to fully understand and utilize all the features and tags available in JSDoc.
• Manual Effort
  Writing JSDoc comments requires a manual effort from developers, which can be time-consuming especially for large codebases.
• Not Enforced
  Without proper enforcement, developers might omit JSDoc comments, leading to inconsistent documentation.
• Overhead
  Too many comments can make the codebase cluttered and harder to navigate in some cases.
• Limited to JavaScript
  JSDoc is primarily designed for JavaScript, which can be limiting if the project includes multiple languages.

• Efficiency
  Once learned, Vim can significantly speed up text editing with its modal editing, keyboard shortcuts, and commands that allow for quick navigation and manipulation of text.
• Lightweight
  Vim is a very lightweight editor, consuming minimal system resources, making it highly performant even on systems with lower specifications.
• Customizability
  Vim is highly configurable and extensible through plugins and user-defined settings, allowing users to tailor the editor to their specific needs.
• Ubiquity
  Vim is available on almost every Unix-like system and even on Windows, making it a ubiquitous tool that you can rely on being available in most environments.
• Support for Multiple Programming Languages
  Vim supports a wide range of programming languages out of the box and offers syntax highlighting, which can be enhanced through plugins.
• Powerful Search and Replace
  Vim offers robust searching and replacing functionalities, including support for regular expressions, which can be a powerful tool for developers.

Possible disadvantages

• Steep Learning Curve
  Vim's modal editing and extensive set of commands can be daunting for new users, requiring significant time and effort to master.
• Minimal Default Config
  The default configuration of Vim is quite minimalistic, which may necessitate additional setup and customization to meet modern development needs.
• Limited GUI
  Vim primarily operates in a terminal, and while there are graphical variants like GVim, they are not as feature-rich or user-friendly as modern GUI editors.
• Plugin Management
  While Vim is highly extensible, managing and configuring plugins can be cumbersome compared to more modern editors that offer integrated plugin management.
• Inconsistent Behavior Across Platforms
  There may be inconsistencies in behavior or available features of Vim across different operating systems, which can complicate its use in certain environments.
• Lack of Integrated Modern Features
  Vim lacks some modern IDE features like integrated debugging, advanced code introspection, and refined autocompletion, which often require third-party plugins to achieve.

ep1 - Documenting your javascript code like a pro, setting up JSdoc

More videos

What Vim Is and Why You Should Learn It

More videos

• 20 Best Web Project Documentation Tools
  bashooka.com · Sep 2020

  It is to Sass what JSDoc is to JavaScript: a documentation system to build pretty and powerful docs in the blink of an eye.

• Boost Your Productivity with These Top Text Editors and IDEs
  convesio.com · Nov 2023

  Vim offers a variety of features like split windows, macros, and extensive customization options. It has a steep learning curve, but once you master it, you’ll be amazed at the speed and productivity it brings to your...

• 13 Best Text Editors to Speed up Your Workflow
  kinsta.com · Sep 2023

  It’s tough to say which developers would enjoy Vim as a text editor. It’s an old system with an outdated interface. Yet, it still has the charm and powerful feature-set that the average developer needs. I would...

• 12 Best LaTeX Editors You Should Use
  beebom.com · Dec 2021

  The entire installation process is perfectly documented on their Sourceforge page, which you must definitely pay a visit. There is another standalone Vim software, known as the gVim that brings a GUI-based interface...

View more

• Express Setup: Simple & Scalable

  In our JSDoc comments we describe our endpoints to using a set of tags, you can look at the different tags and what they do over on JSDoc's website but here's what we've used and why. - Source: dev.to / over 1 year ago

• Connecting the Custom Elements Manifest to Figma Code Connect

  Most analysers that generate a Custom Elements Manifest operate by extending JSDoc comments. In our case, we'll need to add a @figma tag to our component comments so that we can tie the two together. The URL provided here can be found... - Source: dev.to / about 1 year ago

• Ask HN: Abandoned/dead projects you think died before their time and why?

  If your IDE supports JSDoc, then TS isn't needed for basic type constraints. https://jsdoc.app/. - Source: Hacker News / about 1 year ago

View more

• regular Vim has lua?!

  Lua is quite small, encouraging distros to include it. The ubuntu gvim has, and the gvim AppImage linked from vim.org does. The default Makefile from github is set up to not include it, but you can uncomment one line there to get it. Source: over 3 years ago

• is there a way to make highlighted text persistent after quit when using something like [match Search /\%'.line('.').'l/] ?

  I've not used vimwiki locally (tho I'm old enough to remember the Vim wiki on vim.org :), but I think what you are wanting to do is extend vimwiki's syntax file. I presume it installs one at $VIMRUNTIM/syntax or or ~/.vim/syntax. If... Source: almost 4 years ago

• vim.org - Is there a reason for this 1800s-esque design?

  Vim.org has 242k total visitors, tailwindcss.com has 4.4m, planetscale.com has 412k, jpl.nasa.gov has 2.6m, all built with Tailwind, all several years younger than Vim's website. Unnecessary comparison, unnecessary defence. It's a... Source: about 4 years ago

View more