cases to fail • Verify that new code passes its own test cases • Practice defensive programming • Comments • It's much easier to find defects in modular, well-designed code with well-written and extensive with print statements • In more complex systems, take advantage of existing logging facilities • Comments • Great way to stay "on the path" when developing new code • An easy first step in narrowing down ) • Call tracers and domain-specific diagnostic tools (strace, wireshark, SQL analyzers...) • Comments • Very powerful tools for deterministic problems • Not always useful for non-deterministic problems

created for each input file, with the contents of the file copied into the content stream. Special comments in the input files are parsed to define the page dimensions and font and image resources. Example available at: https://ghostscript.com/~julian/ mupdf-bindings/ • All content is generated from the comments in MuPDF header files. • This documentation is generated from an internal development tree, so free-standing wrappers. – Various improvements to enums and non-copyable class wrappers. – Use /** ... */ comments in generated code so visible to Doxygen. – Improvements to and fixes to reference counting. ∗

CppCon 2023 - Finding Your Codebases C++ RootsDocumentation Changes • Source Control • Headers & Comments • External Documentation • Documentation Requirements 27 of 45 CppCon 2023 - Finding Your Codebases 29 of 45 CppCon 2023 - Finding Your Codebases C++ RootsANSI C Compiled with a C++ Compiler • C++ Comments • Less typedefs for structs 30 of 45 CppCon 2023 - Finding Your Codebases C++ RootsPre C++11 • the past (comments) • Increases confusion • Understand what you are documenting so it makes sense • Don’t just read the code, restate it and hope for the best • Document with your comments (commit messages)

freebsd.org/cgi/man.cgi?query=fail ● Define failpoints by comments ○ gofail enable converts comments to code ○ gofail disable converts code to comments Gofail in TiDB func (txn *tikvTxn) Commit(ctx context will use the same failpoint ● No tools to enable and disable the failpoint automatically ● Code in comments can’t be analyzed by static analysis tools https://github.com/pingcap/failpoint The ideal form

created for each input file, with the contents of the file copied into the content stream. Special comments in the input files are parsed to define the page dimensions and font and image resources. Example available at: https://ghostscript.com/~julian/ mupdf-bindings/ • All content is generated from the comments in MuPDF header files. • This documentation is generated from an internal development tree, so free-standing wrappers. – Various improvements to enums and non-copyable class wrappers. – Use /** ... */ comments in generated code so visible to Doxygen. – Improvements to and fixes to reference counting. ∗

Entry(tornado.web.UIModule): def render(self, entry, show_comments=False): return self.render_string( "module-entry.html", entry=entry, show_comments=show_comments) Tell Tornado to use uimodules.py using the ui_modules in entries %} {% module Entry(entry) %} {% end %} and entry.html: {% module Entry(entry, show_comments=True) %} Modules can include custom CSS and JavaScript functions by overriding the embedded_css margin-bottom: 1em; }" def render(self, entry, show_comments=False): return self.render_string( "module-entry.html", show_comments=show_comments) Module CSS and JavaScript will be included once no

created for each input file, with the contents of the file copied into the content stream. Special comments in the input files are parsed to define the page dimensions and font and image resources. Example available at: https://ghostscript.com/~julian/ mupdf-bindings/ • All content is generated from the comments in MuPDF header files. • This documentation is generated from an internal development tree, so free-standing wrappers. – Various improvements to enums and non-copyable class wrappers. – Use /** ... */ comments in generated code so visible to Doxygen. – Improvements to and fixes to reference counting. ∗

created for each input file, with the contents of the file copied into the content stream. Special comments in the input files are parsed to define the page dimensions and font and image resources. Example available at: https://ghostscript.com/~julian/ mupdf-bindings/ • All content is generated from the comments in MuPDF header files. • This documentation is generated from an internal development tree, so automatically handle reference counting so class instances can be copied arbitrarily. • C header file comments are copied into the generated C++ header files. • Compile and link the generated C++ code to create

○ careers@istraresearch.com ● Always happy to learn and explore ○ Please - ask questions, make comments 2 Slidesroi.barkan@gmail.com Outline ● Libraries ○ What ○ Why ○ How ● Ranges ○ Introduction novel ways ● “Go catch rabbits” ● Thank you !! ○ Questions and comments are welcome ○ Thanks to Bryce Lelbach for review and comments 27 Slides

UIModule): def render(self, entry, show_comments=False): return self.render_string( "module-entry.html", entry=entry, show_comments=show_comments) Tell Tornado to use uimodules.py using entries %} {% module Entry(entry) %} {% end %} and entry.html: {% module Entry(entry, show_comments=True) %} Modules can include custom CSS and JavaScript functions by overriding the embedded_css margin-bottom: 1em; }" def render(self, entry, show_comments=False): return self.render_string( "module-entry.html", show_comments=show_comments) Module CSS and JavaScript will be included