#JsDoc

[kkmcshouty]

More code stuff cause funnily enough this is somehow easier to post progress on than actual art. That said, I'm slowly but steadily building my own stream overlay for twitch!

Worst part of this is was the fact that the documentation would have you think that you need to replace the emotes one by one in the code (since the emotes start as just text) but NOPE. When getting the chat messages through StreamerBot there's this fun little section titled "parts" which has the message pre-setup and ready to go in cute little pieces, telling you if they're emotes or normal text or not and they're all in order too! Unlike the section labeled "emotes" which for SOME reason is sorted by id and not position.

tl;dr/say that again in english: I wrote 300ish lines of intricate code just to find there was a simpler way to do it. So simple I'd say it would be usable to teach to beginners as an example project ;; I was able to reuse about 50 lines with minor modification but man. I wasn't expecting EMOTES to take two 9hr days to properly code in

[guiltiest-gear]

Coding

Okay no but literally

This is coding exactly

It doesn't matter if you cooked in those first 2k lines, or if you carbonized that shit, the further you go, the more you regret starting this damn project, learning how to code, and even learning about computers in the first place

This was approximately my experience with JS

I hated every fucking second of it because of the goddamn lack of types

I'm aware you can add type hints in jsdoc and there's also TypeScript too

However, JS and its derivatives gives me a massive fucking headache, and I regret learning it in the first place

[guzsdaily]

Everything is Migrated

Daily Blogs 318 - Sep 18th, 12.024

Finally ended the configuration for the Capytal's Forgejo instance. And spent all day migrating all the projects from GitHub and Codeberg to the instance, with mirroring configuration for backup and ease for outside contributions.

Hopefully this week I can start the prototype of the next project, will make it with SvelteKit, since JavaScript it is faster to develop. But the after it, everything will be rewritten in the normal stack of Go, HTMX, Templ, and vanilla JavaScript (with JSDocs).

Today's artists & creative things Music: Split Idol - by GHOST

© 2024 Gustavo "Guz" L. de Mello. Licensed under CC BY-SA 4.0

[fromdevcom]

In the ever-evolving world of software development, adopting effective coding practices is crucial for ensuring code quality, maintainability, and efficiency. Here are ten essential coding practices every developer should follow to excel in their craft. 1. Write Clean and Readable Code Clean code is easy to read, understand, and maintain. Use meaningful variable names, consistent formatting, and avoid complex logic. Comment your code where necessary, but aim for self-explanatory code that minimizes the need for comments. 2. Follow Consistent Coding Standards Adhering to a consistent coding standard helps maintain uniformity across the codebase, making it easier for team members to collaborate. Popular standards include PEP 8 for Python and the Google Java Style Guide. 3. Use Version Control Systems Version control systems (VCS) like Git allow developers to track changes, collaborate efficiently, and revert to previous versions if needed. Familiarize yourself with basic Git commands and workflows to manage your code effectively. 4. Write Unit Tests Unit tests verify that individual components of your code work as expected. Writing tests ensures that new changes do not break existing functionality and helps maintain a high level of code quality. Use testing frameworks like JUnit for Java or pytest for Python. 5. Practice Code Reviews Code reviews provide an opportunity to catch errors, improve code quality, and share knowledge within the team. Review code changes thoroughly and provide constructive feedback. As a reviewer, focus on readability, logic, and adherence to coding standards. 6. Refactor Regularly Refactoring involves improving the internal structure of the code without changing its external behavior. Regular refactoring helps eliminate technical debt, improve code readability, and make the codebase more maintainable. Focus on simplifying complex functions and removing redundancies. 7. Optimize for Performance Write code that performs efficiently and scales well with increasing data or user load. Profile your code to identify bottlenecks and optimize critical sections. Avoid premature optimization; focus on writing clear and correct code first, then optimize as needed. 8. Keep Learning and Adapting The tech industry evolves rapidly, and staying up-to-date with the latest trends, tools, and practices is essential. Follow industry blogs, participate in forums, and take online courses to continuously improve your skills. 9. Document Your Code Good documentation helps others understand your code and its intended use. Write clear and concise documentation for your functions, classes, and modules. Use tools like JSDoc for JavaScript or Sphinx for Python to generate documentation automatically. 10. Practice Continuous Integration and Deployment (CI/CD) CI/CD automates the process of integrating code changes, running tests, and deploying applications. This practice ensures that code changes are tested and deployed quickly and reliably. Use CI/CD tools like Jenkins, Travis CI, or GitHub Actions to streamline your workflow. Conclusion By following these ten essential coding practices, developers can create high-quality, maintainable, and efficient code. These practices not only improve individual productivity but also foster better collaboration and code management within teams. Embrace these habits to elevate your development skills and contribute to building robust software solutions.

[souhaillaghchimdev]

Developing Open Source Programming Libraries

Open source libraries are essential tools that drive innovation and collaboration in the programming world. They help developers save time, encourage knowledge sharing, and improve software quality. If you've ever thought about giving back to the developer community, building your own open source library is a fantastic way to start.

What is a Programming Library?

A programming library is a collection of reusable code, functions, or classes that help developers perform common tasks without rewriting code from scratch. Examples include libraries for handling dates, making HTTP requests, or performing complex mathematical operations.

Why Build an Open Source Library?

Contribute to the community: Help other developers solve problems and build better software.

Enhance your skills: Learn software design, testing, and documentation.

Build your reputation: Demonstrate your knowledge and gain recognition in the dev community.

Get feedback: Collaborate with developers from around the world and improve your code.

Steps to Build an Open Source Library

Identify a Problem: Find a common pain point or a repetitive task that you can simplify with code.

Plan Your Library: Outline features, structure, and language-specific conventions.

Write Clean Code: Use modular, readable, and well-documented code.

Include Tests: Unit and integration tests ensure your library works as expected.

Write Documentation: Explain how to install, use, and contribute to your library.

Choose a License: Pick an open source license (like MIT, GPL, Apache) to define how others can use your code.

Publish Your Library: Share it on GitHub and package it for ecosystems like npm (JavaScript), PyPI (Python), or crates.io (Rust).

Tools You Might Use

Git & GitHub: For version control and collaboration.

CI/CD Tools: Like GitHub Actions for automating tests and deployments.

Package Managers: npm, pip, Maven, etc., depending on your language.

Documentation Tools: JSDoc, Sphinx, or MkDocs to generate professional docs.

Best Practices

Keep your code simple and focused on solving one problem well.

Write thorough documentation and usage examples.

Be responsive to issues and pull requests.

Encourage contributions and create a welcoming community.

Use semantic versioning (SemVer) for clear version management.

Example: A Simple JavaScript Utility Library

Here's a snippet of a function that could go in a utility library: // utils.js export function capitalize(str) { return str.charAt(0).toUpperCase() + str.slice(1); }

You can package this as an npm module and publish it with clear usage instructions and tests.

Conclusion

Building an open source library is a great way to level up as a programmer while making a real impact. Whether it's a simple utility or a full-featured framework, your library can help others while showcasing your skills. Start small, stay consistent, and join the world of open source contributors!

[codezup]

TypeScript for Machine Learning: Using the JSDoc Comments for Documentation and Type Checking

Introduction TypeScript for Machine Learning: Using the JSDoc Comments for Documentation and Type Checking is a powerful tool that enables developers to create robust, maintainable, and scalable machine learning models. In this tutorial, we will explore how to use JSDoc comments to document and type-check your machine learning code, making it easier to collaborate with others and catch errors…

[technology-moment]

What is the Use of Software Development Tools?

Software development tools are essential for creating, testing, and maintaining software applications efficiently. They encompass a wide range of utilities that help developers streamline their workflow, enhance productivity, and ensure code quality. Here’s a breakdown of their key uses:

1. Code Editing and Writing

Integrated Development Environments (IDEs): Tools like Visual Studio, IntelliJ IDEA, and Eclipse provide a user-friendly interface for writing code, featuring syntax highlighting, code completion, and error detection. This accelerates the coding process and reduces errors.

2. Version Control

Git and GitHub: Version control systems allow multiple developers to collaborate on a project simultaneously. They track changes, manage code revisions, and facilitate rollbacks when necessary. This is crucial for maintaining the integrity of the codebase.

3. Testing and Debugging

Testing Frameworks: Tools like JUnit and Selenium automate the testing process, ensuring that the software is reliable and functions as intended. Debugging tools help identify and fix errors, which is vital for delivering a stable product.

4. Continuous Integration/Continuous Deployment (CI/CD)

Jenkins and Travis CI: These tools automate the integration and deployment process, enabling developers to push changes frequently while minimizing the risk of errors. CI/CD practices improve software quality and accelerate release cycles.

5. Documentation

Markdown Editors and Documentation Generators: Proper documentation is critical for both current developers and future maintainers. Tools like Doxygen and JSDoc help generate comprehensive documentation automatically, improving code understandability.

6. Project Management

Trello, Jira, and Asana: These tools facilitate agile project management, helping teams plan, track, and manage tasks efficiently. They enhance communication and organization within development teams.

7. Collaboration

Slack and Microsoft Teams: Communication tools enable real-time collaboration among team members, regardless of their geographical location. They support code reviews and discussions, which can enhance the overall development process.

8. Performance Monitoring

APM Tools like New Relic and Datadog: These tools monitor applications in real-time, providing insights into performance bottlenecks and user experience issues. This allows developers to make data-driven decisions for optimization.

Conclusion

In summary, software development tools play a crucial role in the software development lifecycle. They enhance productivity, improve code quality, and facilitate collaboration among developers. By leveraging these tools, teams can deliver high-quality software more efficiently and effectively.

If you have any further questions or want to learn more about specific tools, feel free to ask!

[ro-botany]

jsdoc my fucking beloathed

[tomasz-smykowski]

Typescript 5.3 released:

- Import attributes like the type of the import

- resolution mode for imports e.g. require or import

- switch case type narrowing

- type narrowing when comparing to true and false

- type narrowing of custom instanceof resolvers

- inlay hints to go to type definition

- verbatim module syntax at the IDE level

- less jsdoc parsing

- faster intersection type checking

- 20% reduction of package size

Would you like to see an article about these changes? Let me know!

#typescript

[geomurmur]

Chronicle your Coding Journey with JSDoc

https://geo-jobe.com/guides/chronicle-your-coding-journey-with-jsdoc/?utm_source=dlvr.it&utm_medium=tumblr v @JeremyHWeber

[bcbrito]

TypeScript: “não vale a pena” / Nova IA do STF / Minerador duplo uso

Curiosidade para o dia 15 de maio: em 2001, a Apple anunciava a primeira loja de sua rede de varejo – o plano, na época, foi ridicularizado por analistas de tecnologia.  Rich Harris, criador do Svelte, acredita que TypeScript “não vale a pena”: ele defende o uso do conjunto JavaScript e JSDoc no core do framework – a abordagem possui todos os benefícios de segurança do TypeScript, sem a…

[hackernewsrobot]

TypeScript is 'not worth it' Svelte switches to JavaScript and JSDoc

https://devclass.com/2023/05/11/typescript-is-not-worth-it-for-developing-libraries-says-svelte-author-as-team-switches-to-javascript-and-jsdoc/ Comments

[improveyourcodingskills]

TypeScript is 'not worth it' for developing libraries, says Svelte author, as team switches to JavaScript and JSDoc • DEVCLASS

[binaryenigma]

JavaScript my beloved... Don't forget to JSDoc everything

i wish i could throw tomatoes at javascript. i wish javascript was a person or building and i could throw mushy tomatoes at it

[programmerhumour]

Demoted to professional jsdoc writer