rspec/rules/S1644/vb6/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

41 lines
770 B
Plaintext

== Why is this an issue?
Because Visual Basic 6 does not automatically unload ``++Form++`` s after a program terminates, it is possible for them to remain in memory. Even after ``++Unload++`` ing, they may stay in memory if references remain. Therefore ``++Form++`` s should be explicitly ``++Unload++`` ed, and their references set to ``++Nothing++``.
=== Noncompliant code example
[source,vb6]
----
dim f1 as new form
f1.show
...
f1.hide
----
=== Compliant solution
[source,vb6]
----
dim f1 as new form
f1.show
...
f1.hide
Unload f1
Set f1 = Nothing
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
"Unload" this form and set its reference to "Nothing"
endif::env-github,rspecator-view[]