We may earn an affiliate commission when you visit our partners.

droidcon NYC '19

//TODO: Write a Better Comment

Comments have the potential to make or break a codebase. Helpful comments can save you from a lot of reading and debugging. Poor comments can send you on wild goose chases toward something that turns out to be a different problem after all. In this talk, Adam McNeilly will teach you how to differentiate between unhelpful and helpful comments. Adam will also discuss when you can remove a comment entirely and when you can optimize the helpfulness of the ones you keep. By the end, you'll have an understanding of how code and comments coexist, and how to leverage comments for long term benefits in your projects.

Enroll now

Or start your subscription today

And complete this course over a free trial

Here's a deal for you

We found an offer that may be relevant to this course.

Save money when you learn. All coupon codes, vouchers, and discounts are applied automatically unless otherwise noted.

Valid for a limited time only

Future-proof your career

Access O'Reilly books, live events, courses, and more. Save with an annual subscription.

Take

15%

off

Good to know

Know what's good

, what to watch for

, and possible dealbreakers

Builds a strong foundation for beginners by exploring unhelpful and helpful code comments

Useful to professionals who need to create helpful code comments

Provides guidance on when to add, remove, and optimize code comments for a long term benefit in codebases

Taught by droidcon NYC, a respected source in the tech community

This course is taught by Adam McNeilly, a recognized expert in code comments

Save this course

Save droidcon NYC '19: //TODO: Write a Better Comment to your list so you can find it easily later:

Save

Activities

Coming soon We're preparing activities for droidcon NYC '19: //TODO: Write a Better Comment. These are activities you can do either before, during, or after a course.

Career center

Learners who complete droidcon NYC '19: //TODO: Write a Better Comment will develop knowledge and skills that may be useful to these careers:

Software Developer

Software developers design, code, and test software. They may also work on the design and implementation of software systems. This course can help those in the early stages of their career successfully enter this field as well as helping seasoned developers refine their skills in commenting.

See salaries and explore the career path for Software Developer

Software Engineering Manager

Software engineering managers lead teams of software engineers and are responsible for the planning, development, and deployment of software systems. Understanding best practices for commenting and code documentation can greatly benefit the management team's ability to set and enforce standards. This course can be useful to those who find themselves in this management role.

See salaries and explore the career path for Software Engineering Manager

Web Developer

Web developers design and develop websites. They may also work on the design and implementation of web applications. Well-commented code and documentation can greatly benefit those who maintain and update code in the future. This course can be useful for those who wish to succeed in this field.

See salaries and explore the career path for Web Developer

Front-End Developer

Front-end developers are responsible for the design and implementation of the user interface of a website or web application. They work with back-end developers to ensure that the user interface is consistent with the functionality of the application. This course may be helpful to those who wish to succeed in this field.

See salaries and explore the career path for Front-End Developer

Technical Writer

Technical writers are masters of taking complex information and simplifying it in such a way that it is easily understood by the audience. Many times this involves working closely with engineers and other subject matter experts to ensure that the documentation produced is accurate and clear. This course can help build a foundation for those who wish to enter this career field.

See salaries and explore the career path for Technical Writer

Quality Assurance Analyst

Quality assurance analysts test software to find bugs and ensure that it meets the requirements. They often write test plans and reports. Producing detailed and well-commented test cases can greatly benefit the efficiency and accuracy of the testing process. This course may be useful to those who wish to succeed in this field.

See salaries and explore the career path for Quality Assurance Analyst

Technical Editor

Technical editors typically oversee large-scale documentation projects and ensure consistency of formatting, grammar, and tone. As such, they are often responsible for editing and maintaining content created by multiple different authors or subject matter experts. This course can be helpful in building a foundation for those who wish to succeed in this field.

See salaries and explore the career path for Technical Editor

Computer Science Professor

Computer science professors teach students about programming, software engineering, and computer science theory. They may also conduct research in their field. Clear and concise communication is essential to being an effective professor. This course may be useful in building a foundation for those who wish to enter this field.

See salaries and explore the career path for Computer Science Professor

IT Consultant

IT consultants provide expert advice and guidance to organizations on how to use information technology to achieve their business goals. They often work with clients to develop and implement IT solutions. This course can help build a foundation for those who wish to enter this field.

See salaries and explore the career path for IT Consultant

Technical Support Engineer

Technical support engineers help troubleshoot and resolve issues for customers, oftentimes with limited information. Having a strong understanding of comments and documentation can help ensure that the issues are fixed efficiently and effectively. This course may be useful to those who wish to be successful in this field.

See salaries and explore the career path for Technical Support Engineer

Technical Project Manager

Technical project managers plan, execute, and close out technical projects. They work with stakeholders to define the project scope, develop the project plan, and track the project progress. This course may be helpful for those who wish to succeed in this field.

See salaries and explore the career path for Technical Project Manager

IT Manager

IT managers plan, coordinate, and direct computer-related activities within an organization. They often work with vendors and other external partners to ensure that the organization's IT systems are running smoothly. As such, clear and concise commenting can be essential to track the work of outside vendors. This course may be useful to those who wish to succeed in this field.

See salaries and explore the career path for IT Manager

Software Engineer

In software engineering, it is essential to produce well-commented code. Whether it be for your own future reference, or to help onboard new team members, helpful comments can make a world of difference. Understanding how to best leverage comments can lead to a robust codebase as well as a tight-knit team with access to all the information they need to succeed. This course may be helpful for those who wish to succeed in this field.

See salaries and explore the career path for Software Engineer

Systems Engineer

Similar to software engineering, systems engineers often find themselves working on projects with a wide scope. This includes dealing with a variety of stakeholders, being able to translate between technical and non-technical terms, and managing a variety of hardware and software. As such, working with a team to create a well-commented knowledge database can greatly benefit both short-term and long-term projects. This course may be helpful for advancement in this field.

See salaries and explore the career path for Systems Engineer

Architect

Architects design structures to be practical, safe, and aesthetically pleasing. Their work must be documented thoroughly so that builders can construct the structure as intended. This course may be helpful in developing important skills that can be used to succeed in this field.

See salaries and explore the career path for Architect

Reading list

We've selected 16 books that we think will supplement your learning. Use these to develop background knowledge, enrich your coursework, and gain a deeper understanding of the topics covered in droidcon NYC '19: //TODO: Write a Better Comment.

Clean Craftsmanship