Have an idea, suggestion, or something that doesn’t work as expected in InterSystems products or services? Share it here on the InterSystems Ideas Portal.
The Ideas Portal is where community members can propose improvements, report bugs, and help influence the product roadmap across InterSystems products and the overall developer experience. 22% of submitted ideas are implemented by InterSystems or members of the Developer Community.
💡 Ideas and bugs are both welcome, no matter how big or small. You can submit feature requests, usability improvements, workflow suggestions, and bug reports. Whether you’re an experienced expert or just getting started, your fresh perspective is valuable.
🛠️ About bugs and fixes. If you have access to InterSystems WRC, please submit bugs there for immediate action. Bug reports submitted through the Ideas Portal are reviewed and tracked, but do not guarantee immediate resolution.
Start by sharing what could be better - the community and our teams will help take it from there.
Thank you for your comments Raj & Vadim;
Please find my idea in detail below.
Dynamic Cheat Sheet: Empowering Developers with Enhanced IDE Features
Introduction: My proposed idea aims to improve the functionalities of IDE (Cache Studio or Visual Code) by introducing a dynamic cheat sheet feature. This feature will provide developers with quick access to a repository of common core functions, allowing them to enhance their coding efficiency, reusability, accuracy, and maintain consistency across projects.
Problem Statement: When working on region or site-specific code development, developers often find themselves reinventing the wheel by implementing / creating functions that already exist in the core libraries. This not only wastes valuable time but also hinders code accuracy and consistency.
Solution: My solution is to integrate a dynamic cheat sheet within the IDE, which will serve as a comprehensive reference for common core functions. By implementing this feature, developers will benefit from the following advantages:
Reusability: The dynamic cheat sheet will provide developers with instant access to a wide range of pre-existing core functions. They can leverage these functions instead of reinventing the wheel, saving time and effort in writing and testing redundant code.
Time Efficiency: Developers will no longer need to spend time researching, writing, and debugging functions that already exist. With the dynamic cheat sheet, they can quickly locate the required core function, significantly reducing development time.
Accuracy: Core functions are typically thoroughly tested and refined, ensuring their reliability and accuracy. By utilizing these pre-existing functions, developers can leverage the stability and quality assurance already embedded within them.
Consistency: The dynamic cheat sheet will serve as a central repository for core functions, ensuring consistent usage across the entire system. Regardless of the developer's location within the codebase, they can rely on the same set of established core functions, promoting code uniformity and reducing the chances of errors caused by inconsistency.
Conclusion: Introducing a dynamic cheat sheet feature within IDE will greatly enhance the coding experience for developers. By providing quick access to common core functions, we empower developers to improve their productivity, reduce code duplication, and maintain accuracy and consistency. Implementing this feature will significantly elevate the overall development process, benefiting both individual developers and the entire software development teams across regions.
To explain this with some examples:
Example 1: Extend and Re-Use
Number to Text Conversion when printing on a receipt
To achieve this will have to write our own code or use some 3rd party library etc.
If there is a well defined function anyone can extend and reuse it.
Example 2: Copy and Re-Implement code chunks
Let's say the task is to create a new Report which will use ^CacheTemp
If we can have a cheat-sheet having the template of such Stored Procedures.
It will save a lot of development / testing / code review time.
Example 3: One Click Re-use of code logics
Let's say there is a scenario to calculate Length of Stay (LOS)
This type of code often confuses the developer and the tester when each developer uses there own variable names and code logic. Rather if we can have a common code chunk where it will used undoubtedly everywhere across.
@Shareek Ahamed, you have a question about your idea. Please answer it to help your idea to be promoted.
Can you add more detail? I'm not sure what you're asking for.