This content originally appeared on DEV Community and was authored by Itai Katz
Integrating documentation inside the IDE is a convenient method for documentation management. I don't know about you, but I avoid context switching at all costs. I just know how fast I can break my focus.
The easiest way for me to document my code is right in my IDE. Here are three advantage:
- It reduces context switching. When I'm looking at code and I want to understand something about it, the documentation is right there. I don't need to leave my IDE and search for info.
- I see which parts of the code have been already documented while I'm reading and I make a note to come back later and fill in the blanks.
- Reviewing annotations when implementing new code or trying to understand a part of the code- it's more straightforward, easier to review, and just intuitive.
Have you tried IDE-integrated documentation?
This content originally appeared on DEV Community and was authored by Itai Katz
Print
Share
Comment
Cite
Upload
Translate
Updates
There are no updates yet.
Click the Upload button above to add an update.
APA
MLA
Itai Katz | Sciencx (2022-02-21T14:07:58+00:00) The advantages of IDE integrated documentation. Retrieved from https://www.scien.cx/2022/02/21/the-advantages-of-ide-integrated-documentation/
" » The advantages of IDE integrated documentation." Itai Katz | Sciencx - Monday February 21, 2022, https://www.scien.cx/2022/02/21/the-advantages-of-ide-integrated-documentation/
HARVARDItai Katz | Sciencx Monday February 21, 2022 » The advantages of IDE integrated documentation., viewed ,<https://www.scien.cx/2022/02/21/the-advantages-of-ide-integrated-documentation/>
VANCOUVERItai Katz | Sciencx - » The advantages of IDE integrated documentation. [Internet]. [Accessed ]. Available from: https://www.scien.cx/2022/02/21/the-advantages-of-ide-integrated-documentation/
CHICAGO" » The advantages of IDE integrated documentation." Itai Katz | Sciencx - Accessed . https://www.scien.cx/2022/02/21/the-advantages-of-ide-integrated-documentation/
IEEE" » The advantages of IDE integrated documentation." Itai Katz | Sciencx [Online]. Available: https://www.scien.cx/2022/02/21/the-advantages-of-ide-integrated-documentation/. [Accessed: ]
rf:citation » The advantages of IDE integrated documentation | Itai Katz | Sciencx | https://www.scien.cx/2022/02/21/the-advantages-of-ide-integrated-documentation/ |
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.