Browse

JavaDocs .cursorrules prompt files

JavaDocs is a tool for generating API documentation in HTML format from Java source code, improving code readability and maintainability by providing clear and structured information.

Filters

All

React

Tailwind CSS

Filters

Tech

Clear

React

Tailwind CSS

Node.js

Tailwind

JavaScript

Shadcn UI

Next.js

Radix UI

Python

WebP

Zod

JSX

Vite

CSS

Supabase

HTML

Jest

Next.js App Router

PostgreSQL

Docker

Redis

Pydantic

Tailwind Aria

TailwindCSS

FastAPI

Git

ESLint

pytest

react-hook-form

Solidity

Vercel

JSDoc

GitHub Actions

Typescript

Prettier

Suspense

Vitest

ARIA

Zustand

React Testing Library

Celery

Radix

Shadcn

SQLAlchemy

PHP

SvelteKit

JSON

Vue.js

Pinia

MongoDB

tRPC

Clerk

Expo

PEP 8

SSR

Prisma

dotenv

GitLab CI

SQLite

SQL

Playwright

tanStackQuery

DaisyUI

Laravel

RESTful API

Drizzle ORM

VueUse

Express

asyncpg

TypeScript

scikit-learn

pandas

GitHub

RabbitMQ

Rust

Java

GraphQL

Svelte

Elixir

ES6

Nuxt 3

styled-components

Vue Router

Astro

Svelte 5

Markdown

OpenZeppelin

Drizzle

Stripe

Flexbox

CORS

Lighthouse

JWT

Swagger

aiomysql

Ruff

Langchain

Django

matplotlib

Clear

Web Development

Frontend Development

Code Style

Programming

Naming Conventions

Testing

State Management

Backend Development

Code Optimization

Software Engineering

Accessibility

Programming Best Practices

Responsive Design

Code Structure

Version Control

Database Management

UI Design

API Development

Code Quality

TypeScript Best Practices

Authentication

TypeScript

Security

Syntax and Formatting

JavaScript

Best Practices

Data Fetching

Internationalization

Coding Best Practices

React

performance optimization

Performance Optimization

Software Development

Coding Standards

API Integration

Object-Oriented Programming

Code Review

Testing and Debugging

Image Optimization

SEO

Game Development

Code Readability

Deployment

Clean Code

User Interface

JavaScript Frameworks

UI Components

UI and Styling

Declarative Programming

Code Modularity

Security Best Practices

Web Application Development

Error Handling

UI Development

JavaScript Libraries

Design Patterns

TypeScript Guidelines

Server-Side Rendering

TypeScript Usage

Programming Guidelines

Modularization

Code Documentation

error handling

functional programming

Coding Style

Scalability

Form Validation

SEO Optimization

Smart Contracts

Dependency Injection

Test-Driven Development

Static Site Generation

Routing

File Organization

Code Organization

Coding Guidelines

Testing and Quality Assurance

Technical Writing

API Design

Node.js

Full Stack Development

Python development

CI/CD

UI/UX design

Functional Programming

Documentation

Python

Validation

Performance

Code Formatting

Python programming

Code Maintainability

Build and Deployment

Decentralized Applications

Artificial Intelligence

Project Management

Web Vitals

Server Components

Blockchain

Coding Practices

Show

5

rules

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form.

NEW

Java Programming Guide .cursorrules prompt file

// Version: 1.0

Universal Java Cursor Rules Document

1. Introduction

This document provides guidelines and best practices for Java programming, focusing on core principles and modern practices relevant to Java source code manipulation and understanding. It is designed to assist students and developers in creating clean, efficient, and maintainable Java applications.

2. Java Naming Conventions

Class and Interface Names: Use CamelCase and start with uppercase letters. Examples: DataProcessor, Runnable.
Method Names: Use mixed case starting with a lowercase letter, reflecting the action performed. Example: calculateTotal.
Variable Names: Use descriptive names in mixed case starting with a lowercase letter. Avoid single-character names except for temporary looping variables.
Constants: Use all uppercase with underscores between words. Example: MAX_HEIGHT.
Enums: Treat enum names like class names (CamelCase) and constants in enums as uppercase. Example: enum Color { RED, GREEN, BLUE }.
Type Parameters: Use single uppercase letters. Common conventions include E for element and T for type.

3. Java Documentation Practices

JavaDoc: Properly document all public classes and methods using JavaDoc, focusing on the "why" and "how" of the code.
Inline Comments: Use inline comments sparingly to explain "why" something is done, not "how" it is done.

4. Code Structure and Organization

Modularity: Organize code into packages that reflect functionality and can be reused across different parts of the application.
Error Handling: Use exceptions to handle errors. Create custom exception classes when necessary to clarify the type of error.
Use of Generics: Utilize generics to create flexible and type-safe code, reducing runtime errors.

5. Java Core Libraries Utilization

Collections: Use Java Collections Framework effectively. Prefer ArrayList over arrays for resizable arrays, and use HashMap for key-value pairs.
Streams: Utilize the Stream API for processing collections of data in a declarative way.
Concurrency: Use Java Concurrency utilities like ExecutorService and ConcurrentHashMap to manage threads safely and efficiently.

6. Modern Java Features

Lambda Expressions and Functional Interfaces: Use lambda expressions to create concise and flexible code, particularly with collections and threading.
Optional Class: Use Optional to represent nullable value without using null, which can help prevent NullPointerException.
Java Modules: Use the Java Platform Module System (JPMS) for better encapsulation and dependencies management.

7. Performance Optimization

Avoid Premature Optimization: Focus on writing clear and simple code before optimizing. Use profiling tools to identify bottlenecks.
Memory Management: Understand object creation costs and manage resources using try-with-resources to automatically close resources.

8. Testing and Debugging

Unit Testing: Write unit tests using frameworks like JUnit to ensure each part of the application works as expected independently.
Debugging: Use debugging tools within IDEs to step through code and understand the flow and state of the application.

9. Adherence to Java Language and JVM Specifications

Compliance: Ensure code complies with the Java Language Specification and JVM specifications to avoid platform-specific issues and ensure portability.

10. Ethical and Professional Practices

Code of Conduct: Adhere to ethical coding practices, respecting copyright and licensing of third-party libraries.
Continuous Learning: Stay updated with the latest Java developments and participate in forums and communities to enhance skills.

Universal Java Cursor Rules Document - Updated Section

11. File Naming Conventions

When creating new files within a Java project, it is important to adhere to consistent naming conventions to ensure that files are easily identifiable and accessible. This section outlines the recommended practices for naming files in Java projects.

CamelCase Naming: Use CamelCase for naming Java class files. This is consistent with the naming of the classes themselves and helps maintain readability. Example: UserProfile.java, FileProcessor.java.
Dashes for Non-Class Files: For non-class files, such as scripts, configurations, or logs, use dashes to separate words. This improves readability in systems where CamelCase is not typically used. Example: config-file.properties, error-log.txt.
Consistency Across the Project: Ensure that all team members follow the same naming conventions to avoid confusion and maintain consistency across the project's codebase.
Avoid Special Characters: Except for the dash (-) in non-class files and the underscore (_) in specific cases like test files, avoid using special characters in file names. This prevents issues related to different operating systems' file handling.
Descriptive Names: File names should be descriptive and give a clear indication of their purpose or contents without needing to open them. Avoid vague names like util.java or helper.txt, which do not provide insight into the file's functionality.

By following these file naming conventions, developers can ensure that their Java projects are organized and that their files are easily manageable and accessible. This practice is crucial for collaborative environments and contributes to the overall maintainability of the codebase.

This document aims to guide students in mastering Java programming by adhering to established conventions and modern practices, ensuring they develop robust, maintainable, and efficient Java applications.

stack:

Java

JavaDocs

Java Collections Framework

ArrayList

HashMap