Editing
Best Practices for Elixir Development
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
=== Testing and Documentation === Testing and documentation are essential components of the development process. They enable you to ensure code correctness, enhance maintainability, and facilitate collaboration. Consider the following practices for testing and documentation: * Write comprehensive unit tests using Elixir's built-in testing framework, [https://hexdocs.pm/ex_unit ExUnit]. Aim for high code coverage to minimize the risk of undiscovered issues. * Utilize integration testing frameworks such as [https://github.com/phoenixframework/phoenix_live_view Phoenix LiveView] or [https://github.com/houndci/hound Hound] to test interactions between different components of your application. * Document your code using Elixir's built-in documentation tool, `@doc`, and generate HTML documentation using tools like [https://github.com/lpil/absinthe_docs AbsintheDocs] or [https://github.com/elixir-lang/ex_doc ExDoc]. This ensures that your code is well-documented and accessible to other developers.
Summary:
Please note that all contributions to Elixir Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Elixir Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
View history
More
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
Tools
What links here
Related changes
Special pages
Page information