forked from spotbugs/spotbugs.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
116 lines (86 loc) · 5.56 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>SpotBugs</title>
</head>
<body>
<header>
<div class="inner">
<h1><a href="/index.html">SpotBugs <img src="images/logos/spotbugs_icon_only_zoom_256px.png" width="80" height="80" /></a></h1>
<h2>Find bugs in Java Programs</h2>
<a href="https://github.com/spotbugs/spotbugs" class="button"><small>Check it out on</small> GitHub</a>
</div>
</header>
<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content" class="two-column">
<p>SpotBugs is a program which uses static analysis to look for bugs in Java code. It is free software, distributed under the terms of the <a href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a>.</p>
<p>SpotBugs is a fork of <a href="http://findbugs.sourceforge.net/">FindBugs</a> (which is now an abandoned project), carrying on from the point where it left off with support of its community. Please check <a href="http://spotbugs.readthedocs.io/en/latest/">the official manual</a> for details.</p>
<p>SpotBugs requires JRE (or JDK) 1.8.0 or later to run. However, it can analyze programs compiled for any version of Java.</p>
<h3>
<a id="bug-descriptions" class="anchor" href="#bug-descriptions" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Bug Descriptions</h3>
<p>SpotBugs checks for more than 400 bug patterns. Bug descriptions can be found <a href="https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html">here</a>.</p>
<p>Descriptions are also available in <a href="https://spotbugs.readthedocs.io/ja/latest/bugDescriptions.html">Japanese</a>.</p>
<h3>
<a id="using-spotbugs" class="anchor" href="#using-spotbugs" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Using SpotBugs</h3>
<p>SpotBugs can be used standalone and through several integrations, including:</p>
<ul>
<li><a href="http://spotbugs.readthedocs.io/en/latest/ant.html">Ant</a></li>
<li><a href="http://spotbugs.readthedocs.io/en/latest/maven.html">Maven</a></li>
<li><a href="http://spotbugs.readthedocs.io/en/latest/gradle.html">Gradle</a></li>
<li><a href="http://spotbugs.readthedocs.io/en/latest/eclipse.html">Eclipse</a></li>
</ul>
To automatically configure the Eclipse SpotBugs plugin from the SpotBugs Maven plugin configuration, use <a href="https://github.com/m2e-code-quality/m2e-code-quality/">m2e-code-quality</a>.
<h3>
<a id="extensions" class="anchor" href="#extensions" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Extensions</h3>
<p>SpotBugs is extensible. New detectors can be added through plugins. Popular SpotBugs plugins include:</p>
<ul>
<li><a href="http://fb-contrib.sourceforge.net/">fb-contrib</a></li>
<li><a href="http://h3xstream.github.io/find-sec-bugs/">find-sec-bugs</a></li>
</ul>
<p>Or, you could create your own by checking the documentation:</p>
<p><a href="https://javadoc.io/doc/com.github.spotbugs/spotbugs/">API</a> [<a href="https://javadoc.io/page/com.github.spotbugs/spotbugs/latest/overview-summary.html">no frames</a>]</p>
<h3>
<a id="logo-license" class="anchor" href="#logo-license" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>License of SpotBugs Logo</h3>
<p>Following SpotBugs Logos and Icons are licensed under <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>.</p>
<ul>
<li><a href="images/logos/spotbugs_logo_300px.png">Logo (300px)</a></li>
<li><a href="images/logos/spotbugs_logo_600px.png">Logo (600px)</a></li>
<li><a href="images/logos/spotbugs_icon_only_zoom_256px.png">Icon (256px)</a></li>
<li><a href="images/logos/spotbugs_icon_only_385px.png">Icon (385px)</a></li>
</ul>
<h3>
<a id="support-or-contact" class="anchor" href="#support-or-contact" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Support or Contact</h3>
<p>You can report issues on <a href="https://github.com/spotbugs/spotbugs/issues">GitHub</a>.</p>
<p>Or, you can contact us using <a href="https://github.com/spotbugs/discuss/issues?q=">our general purpose mailing list</a>.</p>
</section>
<aside id="sidebar">
<ul>
<li><a href="#bug-descriptions">Bug Descriptions</a></li>
<li><a href="#using-spotbugs">Using SpotBugs</a></li>
<li><a href="#extensions">Extensions</a></li>
<li><a href="#logo-license">License of SpotBugs Logo</a></li>
<li><a href="#support-or-contact">Support or Contact</a></li>
</ul>
</aside>
</div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-86930553-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>