C#: Convert some multi-line comments

Author: hvitved

csharp/ql/src/Bad Practices/Naming Conventions/ConfusingOverridesNames.ql

@@ -43,19 +43,16 @@ predicate confusing(Method m1, Method m2) {
   )
 }
 
-/*
- * Two method names are confusing if all of the following conditions hold:
- *   They are both static methods or both instance methods.
- *   They are not declared in the same class, and the superclass method is
- *     not overridden in an intermediate class
- *   They have different names.
- *   They have the same names if case is ignored.
- *   There is no method in the subclass that has the same name as
- *     the superclass method
- * There is an additional check that only methods with names longer than one character
- * can be considered confusing.
- */
-
+// Two method names are confusing if all of the following conditions hold:
+//   They are both static methods or both instance methods.
+//   They are not declared in the same class, and the superclass method is
+//     not overridden in an intermediate class
+//   They have different names.
+//   They have the same names if case is ignored.
+//   There is no method in the subclass that has the same name as
+//     the superclass method
+// There is an additional check that only methods with names longer than one character
+// can be considered confusing.
 from Method m1, Method m2
 where
   confusing(m1, m2) and

csharp/ql/src/Metrics/Files/FSelfContainedness.ql

@@ -13,7 +13,7 @@
 import csharp
 import semmle.code.csharp.metrics.Coupling
 
-/* Self-containedness on file level */
+// Self-containedness on file level
 from File f, float selfContaindness, int efferentSourceCoupling, int efferentCoupling
 where
   efferentSourceCoupling = count(File g |

csharp/ql/src/Security Features/CWE-352/MissingAntiForgeryTokenValidation.ql

@@ -26,10 +26,7 @@ class AntiForgeryAuthorizationFilter extends AuthorizationFilter {
  * Holds if the project has a global anti forgery filter.
  */
 predicate hasGlobalAntiForgeryFilter() {
-  /*
-   * A global filter added
-   */
-
+  // A global filter added
   exists(MethodCall addGlobalFilter |
     // addGlobalFilter adds a filter to the global filter collection
     addGlobalFilter.getTarget() = any(GlobalFilterCollection gfc).getAddMethod() and

csharp/ql/src/Security Features/CWE-451/MissingXFrameOptions.ql

@@ -19,19 +19,16 @@ import semmle.code.csharp.frameworks.system.Web
  * Holds if there exists a `Web.config` file in the snapshot that adds an `X-Frame-Options` header.
  */
 predicate hasWebConfigXFrameOptions() {
-  /*
-   * Looking for an entry in a Web.config file that looks like this:
-   * ```
-   * <system.webServer>
-   *   <httpProtocol>
-   *    <customHeaders>
-   *      <add name="X-Frame-Options" value="SAMEORIGIN" />
-   *    </customHeaders>
-   *   </httpProtocol>
-   * </system.webServer>
-   * ```
-   */
-
+  // Looking for an entry in a Web.config file that looks like this:
+  // ```
+  // <system.webServer>
+  //   <httpProtocol>
+  //    <customHeaders>
+  //      <add name="X-Frame-Options" value="SAMEORIGIN" />
+  //    </customHeaders>
+  //   </httpProtocol>
+  // </system.webServer>
+  // ```
   exists(XMLElement element |
     element = any(WebConfigXML webConfig)
           .getARootElement()

csharp/ql/src/Stubs/MinimalStubsFromSource.ql

@@ -1,4 +1,4 @@
-/*
+/**
  * Tool to generate C# stubs from a qltest snapshot.
  *
  * It finds all declarations used in the source code,

csharp/ql/src/semmle/code/asp/AspNet.qll

@@ -184,15 +184,12 @@ class PageDirective extends AspDirective {
   ValueOrRefType getInheritedType() { result.getQualifiedName() = getInheritedTypeQualifiedName() }
 
   private string getInheritedTypeQualifiedName() {
-    /*
-     * Relevant attributes:
-     * - `Inherits`: determines the class to inherit from, this is what we want
-     * - `ClassName`: determines the name to use for the compiled class, can
-     *   provide a fallback namespace if `Inherits` does not have one
-     * - `CodeBehindFile`/`CodeFile`: used by tooling, but not semantically
-     *   relevant at runtime
-     */
-
+    // Relevant attributes:
+    // - `Inherits`: determines the class to inherit from, this is what we want
+    // - `ClassName`: determines the name to use for the compiled class, can
+    //   provide a fallback namespace if `Inherits` does not have one
+    // - `CodeBehindFile`/`CodeFile`: used by tooling, but not semantically
+    //   relevant at runtime
     exists(string inherits | inherits = getAttributeByName("Inherits").getBody() |
       if inherits.indexOf(".") != -1
       then result = inherits

csharp/ql/src/semmle/code/csharp/Conversion.qll

@@ -307,24 +307,22 @@ private module Identity {
   private predicate convIdentityStrictConstructedType(
     IdentityConvertibleConstructedType fromType, IdentityConvertibleConstructedType toType
   ) {
-    /*
-     * Semantically equivalent with
-     * ```
-     * ugt = fromType.getUnboundGeneric()
-     * and
-     * forex(int i |
-     *   i in [0 .. ugt.getNumberOfTypeParameters() - 1] |
-     *   exists(Type t1, Type t2 |
-     *     t1 = getTypeArgument(ugt, fromType, i, _) and
-     *     t2 = getTypeArgument(ugt, toType, i, _) |
-     *     convIdentity(t1, t2)
-     *   )
-     * )
-     * ```
-     * but performance is improved by explicitly evaluating the `i`th argument
-     * only when all preceding arguments are convertible.
-     */
-
+    // Semantically equivalent with
+    // ```
+    // ugt = fromType.getUnboundGeneric()
+    // and
+    // forex(int i |
+    //   i in [0 .. ugt.getNumberOfTypeParameters() - 1] |
+    //   exists(Type t1, Type t2 |
+    //     t1 = getTypeArgument(ugt, fromType, i, _) and
+    //     t2 = getTypeArgument(ugt, toType, i, _) |
+    //     convIdentity(t1, t2)
+    //   )
+    // )
+    // ```
+    // but performance is improved by explicitly evaluating the `i`th argument
+    // only when all preceding arguments are convertible.
+    //
     fromType != toType and
     (
       convIdentitySingle(_, fromType, toType)
@@ -462,11 +460,8 @@ predicate convNullableType(ValueOrRefType fromType, NullableType toType) {
   )
 }
 
-/*
- * This is a deliberate, small Cartesian product, so we have manually lifted it to force the
- * evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
- */
-
+// This is a deliberate, small Cartesian product, so we have manually lifted it to force the
+// evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
 pragma[noinline]
 private predicate defaultNullConversion(Type fromType, Type toType) {
   fromType instanceof NullType and convNullType(toType)
@@ -491,21 +486,15 @@ private predicate convRefTypeNonNull(Type fromType, Type toType) {
   convRefTypeParameter(fromType, toType)
 }
 
-/*
- * This is a deliberate, small cartesian product, so we have manually lifted it to force the
- * evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
- */
-
+// This is a deliberate, small cartesian product, so we have manually lifted it to force the
+// evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
 pragma[noinline]
 private predicate defaultDynamicConversion(Type fromType, Type toType) {
   fromType instanceof RefType and toType instanceof DynamicType
 }
 
-/*
- * This is a deliberate, small cartesian product, so we have manually lifted it to force the
- * evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
- */
-
+// This is a deliberate, small cartesian product, so we have manually lifted it to force the
+// evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
 pragma[noinline]
 private predicate defaultDelegateConversion(RefType fromType, RefType toType) {
   fromType instanceof DelegateType and toType = any(SystemDelegateClass c).getABaseType*()
@@ -525,11 +514,8 @@ private predicate convRefTypeRefType(RefType fromType, RefType toType) {
   )
 }
 
-/*
- * This is a deliberate, small cartesian product, so we have manually lifted it to force the
- * evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
- */
-
+// This is a deliberate, small cartesian product, so we have manually lifted it to force the
+// evaluator to evaluate it in its entirety, rather than trying to optimize it in context.
 pragma[noinline]
 private predicate defaultArrayConversion(Type fromType, RefType toType) {
   fromType instanceof ArrayType and toType = any(SystemArrayClass c).getABaseType*()
@@ -745,28 +731,25 @@ predicate convConversionOperator(Type fromType, Type toType) {
 
 /** 13.1.3.2: Variance conversion. */
 private predicate convVariance(ConstructedType fromType, ConstructedType toType) {
-  /*
-   * Semantically equivalent with
-   * ```
-   * ugt = fromType.getUnboundGeneric()
-   * and
-   * forex(int i |
-   *   i in [0 .. ugt.getNumberOfTypeParameters() - 1] |
-   *   exists(Type t1, Type t2, TypeParameter tp |
-   *     t1 = getTypeArgument(ugt, fromType, i, tp) and
-   *     t2 = getTypeArgument(ugt, toType, i, tp) |
-   *     convIdentity(t1, t2)
-   *     or
-   *     convRefTypeNonNull(t1, t2) and tp.isOut()
-   *     or
-   *     convRefTypeNonNull(t2, t1) and tp.isIn()
-   *   )
-   * )
-   * ```
-   * but performance is improved by explicitly evaluating the `i`th argument
-   * only when all preceding arguments are convertible.
-   */
-
+  // Semantically equivalent with
+  // ```
+  // ugt = fromType.getUnboundGeneric()
+  // and
+  // forex(int i |
+  //   i in [0 .. ugt.getNumberOfTypeParameters() - 1] |
+  //   exists(Type t1, Type t2, TypeParameter tp |
+  //     t1 = getTypeArgument(ugt, fromType, i, tp) and
+  //     t2 = getTypeArgument(ugt, toType, i, tp) |
+  //     convIdentity(t1, t2)
+  //     or
+  //     convRefTypeNonNull(t1, t2) and tp.isOut()
+  //     or
+  //     convRefTypeNonNull(t2, t1) and tp.isIn()
+  //   )
+  // )
+  // ```
+  // but performance is improved by explicitly evaluating the `i`th argument
+  // only when all preceding arguments are convertible.
   Variance::convVarianceSingle(_, fromType, toType)
   or
   exists(UnboundGenericType ugt |

csharp/ql/src/semmle/code/csharp/Enclosing.qll

@@ -27,14 +27,11 @@ module Internal {
    */
   cached
   predicate enclosingCallable(Stmt s, Callable c) {
-    /*
-     * Compute the enclosing callable for a statement. This walks up through
-     * enclosing statements until it hits a callable. It's unambiguous, since
-     * if a statement has no parent statement, it's either the method body
-     * or the body of an anonymous function declaration, in each of which cases the
-     * non-statement parent is in fact the enclosing callable.
-     */
-
+    // Compute the enclosing callable for a statement. This walks up through
+    // enclosing statements until it hits a callable. It's unambiguous, since
+    // if a statement has no parent statement, it's either the method body
+    // or the body of an anonymous function declaration, in each of which cases the
+    // non-statement parent is in fact the enclosing callable.
     c.getAChildStmt+() = s
   }
 
@@ -50,13 +47,10 @@ module Internal {
    */
   cached
   predicate enclosingStmt(Expr e, Stmt s) {
-    /*
-     * Compute the enclosing statement for an expression. Note that this need
-     * not exist, since expressions can occur in contexts where they have no
-     * enclosing statement (examples include field initialisers, both inline
-     * and explicit on constructor definitions, and annotation arguments).
-     */
-
+    // Compute the enclosing statement for an expression. Note that this need
+    // not exist, since expressions can occur in contexts where they have no
+    // enclosing statement (examples include field initialisers, both inline
+    // and explicit on constructor definitions, and annotation arguments).
     getAChildExpr+(s) = e
   }
 
@@ -76,14 +70,11 @@ module Internal {
    */
   cached
   predicate exprEnclosingCallable(Expr e, Callable c) {
-    /*
-     * Compute the enclosing callable of an expression. Note that expressions in
-     * lambda functions should have the lambdas as enclosing callables, and their
-     * enclosing statement may be the same as the enclosing statement of the
-     * lambda; thus, it is *not* safe to go up to the enclosing statement and
-     * take its own enclosing callable.
-     */
-
+    // Compute the enclosing callable of an expression. Note that expressions in
+    // lambda functions should have the lambdas as enclosing callables, and their
+    // enclosing statement may be the same as the enclosing statement of the
+    // lambda; thus, it is *not* safe to go up to the enclosing statement and
+    // take its own enclosing callable.
     childExprOfCallable(c, e)
     or
     not childExprOfCallable(_, e) and

csharp/ql/src/semmle/code/csharp/Generics.qll

@@ -158,23 +158,20 @@ class TypeParameter extends DotNet::TypeParameter, Type, @type_parameter {
 
   /** Gets a type that was supplied for this parameter. */
   Type getASuppliedType() {
-    /*
-     * A type parameter either comes from the source declaration
-     *      or from a partially constructed generic.
-     *
-     *      When from a source declaration, return type arguments from all ConstructedGenerics,
-     *      and when from a partially constructed UnboundGeneric, return type arguments from
-     *      directly ConstructedGenerics.
-     *
-     *      e.g.
-     *
-     *      class A<T1> { class B<T2> { } }
-     *
-     *      A<T1>.B<T2> is the UnboundGenericClass source declaration,
-     *      A<int>.B<T2> is a partially constructed UnboundGenericClass and
-     *      A<int>.B<int> is a ConstructedGenericClass.
-     */
-
+    // A type parameter either comes from the source declaration
+    // or from a partially constructed generic.
+    //
+    // When from a source declaration, return type arguments from all ConstructedGenerics,
+    // and when from a partially constructed UnboundGeneric, return type arguments from
+    // directly ConstructedGenerics.
+    //
+    // For example:
+    //
+    // class A<T1> { class B<T2> { } }
+    //
+    // A<T1>.B<T2> is the UnboundGenericClass source declaration,
+    // A<int>.B<T2> is a partially constructed UnboundGenericClass and
+    // A<int>.B<int> is a ConstructedGenericClass.
     exists(ConstructedGeneric c, UnboundGeneric u, int tpi |
       this = u.getTypeParameter(tpi) and
       (u = c.getUnboundGeneric() or u = c.getSourceDeclaration()) and

csharp/ql/src/semmle/code/csharp/Property.qll

@@ -178,11 +178,8 @@ class Property extends DotNet::Property, DeclarationWithGetSetAccessors, @proper
   override Expr getAnAssignedValue() {
     result = DeclarationWithGetSetAccessors.super.getAnAssignedValue()
     or
-    /*
-     * For library types, we don't know about assignments in constructors. We instead assume that
-     * arguments passed to parameters of constructors with suitable names.
-     */
-
+    // For library types, we don't know about assignments in constructors. We instead assume that
+    // arguments passed to parameters of constructors with suitable names.
     getDeclaringType().fromLibrary() and
     exists(Parameter param, Constructor c, string propertyName |
       propertyName = getName() and